Skip to content

Commit

Permalink
flesh out wiki-usage-guide
Browse files Browse the repository at this point in the history
  • Loading branch information
Cristiano committed Jun 16, 2019
1 parent 1470264 commit f60be01
Showing 1 changed file with 6 additions and 8 deletions.
14 changes: 6 additions & 8 deletions docs/wiki-usage-guide.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,20 @@
# Wiki Usage Guide

## How to edit a Wiki page
[Nebulas Wiki User Guide](https://medium.com/nebulasio/nebulas-wiki-user-guide-5418715c6988)
A full tutorial on how to edit Wiki pages can be found [here](https://medium.com/nebulasio/nebulas-wiki-user-guide-5418715c6988).

## Editing Software
You should use reST to edit .rst files, and Pandoc Markdown for .md files.
For users who are familiar with git and would like to edit the Wiki locally, reST should be used to edit .rst files, and Pandoc Markdown for .md files.

Click [here](http://www.unexpected-vortices.com/doc-notes/markdown-and-rest-compared.html) to learn about the differences between Pandoc Markdown and reST.

These are some learning resources:
Below are some of the learning resources that can be used to further your knowledge of Markdown:

- [How to use Markdown](https://daringfireball.net/projects/markdown/syntax) by John Gruber
- [Markdown Guide](https://ia.net/writer/support/general/markdown-guide) by iA Writer

When you edit pages on Github, you should click on "Preview changes" to view the result of your labor. You can check the building process [here](https://readthedocs.org/projects/nebdocs/builds/).

## Tracking changes

TBA
## The aftermath

When you edit pages on Github, you should always click on "Preview changes" to view the result of your labor.

After your contribution has been merged, you can check the building process [here](https://readthedocs.org/projects/nebdocs/builds/).

0 comments on commit f60be01

Please sign in to comment.