[TODO] Add Developer Documentation to our GitHub Wiki

[gbowne1]

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

[Gourav2609]

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

[gbowne1]

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]

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

[gbowne1]

Ok @Chizobaonorh

[gbowne1]

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.