sparking2 / docs-test Goto Github PK

The project documentation (stored in the docs directory) is a git subtree of the project wiki. This allows for the documentation to be referenced and edited from within the main project.

When cloning the main project repository for the first time, the wiki repository must be added as a remote.

git remote add wiki https://github.com/<user>/<repo>.wiki.git

New and updated documentation should be committed and pushed in the main project repository just like any other file.

However, care should be taken to ensure documentation files are always committed separately from other project files. Individual commits should never contain both files inside and outside the docs directory.

Documentation changes in the main project repository can be pushed to the wiki repository at any time. This does not need to happen every time documentation is added or updated, but can happen as often as desired.

git subtree push --prefix docs wiki master

If the GitHub website is used to edit wiki files, the push will fail, in which case any updates should be pulled as described below.

It should only be necessary to pull updates directly from the wiki when the GitHub website is used to edit the documentation directly in the wiki. If pushing to the wiki ever fails, try pulling first.

git subtree pull --prefix docs wiki master --squash --message="Merge wiki updates into docs."