home

MRC Documentation Team Wiki

This wiki contains notes and information pertaining to the documentation process for Microsoft Research Connections documentation staff.

MRC Doc Notes

Most MRC projects use GitHub, but each project's unique needs dictate how documentation is produced and presented.

• GitHub wikis are a fast and easy way to do docs for a project. Everyone on the team can contribute easily. GitHub wikis are formatted using Markdown. To clone a GitHub wiki, simply add ".wiki" to the .git filename in the URL. For example:

git clone https://github.com/willum070/docteam.wiki.git

• GitHub IO pages are another great way to present documentation, and they have more graphic options than wiki pages, and are authored using HTML. IO pages are stored in a branch named 'gh-pages'. To clone this branch to work locally, do the following:

git checkout --orphan gh-pages
git rm -rf .
git pull origin gh-pages

In this example we have created a new 'orphan' branch, removed all default files, and then pull the branch.

For more info, see https://help.github.com/articles/creating-project-pages-manually.