Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[TODO] Add Developer Documentation to our GitHub Wiki #141

Open
gbowne1 opened this issue Aug 23, 2023 · 5 comments
Open

[TODO] Add Developer Documentation to our GitHub Wiki #141

gbowne1 opened this issue Aug 23, 2023 · 5 comments
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@gbowne1
Copy link
Owner

gbowne1 commented Aug 23, 2023

We have a CodeBooker wiki here on github.

I think it could be useful to house our user documentation and developer documenation, once completed.

The wiki is here:
https://github.com/gbowne1/codebooker/wiki

You can clone/fork it as a separate repo and push to it from there:
git clone https://github.com/gbowne1/codebooker.wiki.git

@gbowne1 gbowne1 added the documentation Improvements or additions to documentation label Aug 23, 2023
@gbowne1 gbowne1 added this to the Documentation milestone Aug 23, 2023
@Gourav2609
Copy link

hello @gbowne1

You can clone/fork it as a separate repo and push to it from there: git clone https://github.com/gbowne1/codebooker.wiki.git

the site giving this error
image

@gbowne1
Copy link
Owner Author

gbowne1 commented Aug 24, 2023

So @Gorav2609, you can clone the wiki repo by doing git clone https://github.com/gbowne1/codebooker.wiki.git and it will clone a codebooker.wiki folder

If you want to look at the Wiki you can click on the Wiki tab or go to https://github.com/gbowne1/codebooker/wiki and you can directly edit them there, but I find it is easier to edit if you clone the wiki repo separately and open in your editor or IDE.

The wiki can be made in Markdown, and the github guide for that is: https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax

The guide to the wiki is here: https://docs.github.com/en/communities/documenting-your-project-with-wikis/adding-or-editing-wiki-pages

@Chizobaonorh
Copy link
Contributor

Hello, i would love to contribute to this, @gbowne1

@gbowne1
Copy link
Owner Author

gbowne1 commented Sep 20, 2023

Ok @Chizobaonorh

@gbowne1
Copy link
Owner Author

gbowne1 commented Nov 15, 2023

I keep forgetting that the format for GitHub Wiki is Jeckyl so the filenames for this are _filename.md

There's Jeckyl docs on GitHub somewhere.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: Todo
Development

No branches or pull requests

3 participants