Updating Documentation

When a new version of Orbited is released, the documentation needs to be updated and the old documentation needs to be moved out of the main /wiki/Documentation page. How the first task is done will depend on what changed in the release, but basically there are three things to consider:

1. Which pages need to be added?
2. Which pages need to be omitted?
3. Which pages need to be retained but updated?

The Structure of the Documentation

• The current set of docs sits in wiki/ (e.g. wiki/Tutorials). This means you can link to a static URL and always get the current docs for that subject.
• Each old set of docs gets its own directory e.g. wiki/0.x.
• The index page for the current version is /wiki/Documentation; for the old versions it's /wiki/0.x/Documentation. The old index pages are linked to from /wiki/Documentation. This avoids having old doc links clutter up /wiki/Documentation.
• A warning sign appears at the top of old docs saying: it's old, which version it refers to, and a link to /wiki/Development

The Mechanics of Changing the Documentation

1. Create a complete new set of documentation (copying from just-outdated docs as necessary) in wiki/
2. Copy the old /wiki/Documentation page, sans the Dev Docs and Deprecated Docs sections, to /wiki/0.oldnumber/Documentation
3. Change links in wiki/GetStarted and wiki/Documentation to point to new docs in wiki/
4. On the /wiki/Documentation page, add a link under the Deprecated Docs section to the recently created /wiki/0.oldnumber/Documentation page
5. Add the version to the Trac versions list