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

Make a wiki and move documentation from docs/ to it #6

Open
simon-andrews opened this issue Jul 12, 2018 · 0 comments
Open

Make a wiki and move documentation from docs/ to it #6

simon-andrews opened this issue Jul 12, 2018 · 0 comments
Labels
good first issue Good for newcomers

Comments

@simon-andrews
Copy link
Owner

simon-andrews commented Jul 12, 2018

GitHub provides projects with free wikis. UMTK's can be found at https://github.com/simon-andrews/umass-toolkit/wiki

It's currently blank, and it's your job to fix that!

Basically, make a homepage for the wiki, then migrate the stuff in docs/ to its own separate page on the wiki.

GitHub wikis are formatted in a language called Markdown. The stuff in the docs/ folder is written in a language called reStructuredText. docs/ folder stuff should be copied to the wiki and translated from reStructuedText to Markdown.

GitHub wikis have a useful preview feature for you to check your work without publishing it!

Recommended experience:

  • None, really. Comfort with HTML might be useful (since you'll be used to the idea of a Markdown language already), but you don't really need it.
@simon-andrews simon-andrews added enhancement New feature or request good first issue Good for newcomers labels Jul 12, 2018
@simon-andrews simon-andrews removed the enhancement New feature or request label Aug 18, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant