Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • a level 2 heading in the parent page,
  • a level 1 heading in a child page,
  • the title of a grandchild page.

Linking within the document

It's good to include links on the wiki pages, pointing to other areas of the document. However, these links will not be active in the PDF file. The text of the link should be sufficient to find its target.

...

Code

Use a code block macro to represent code.  A title for the code block is optional.

Use monospace in sentences to represent code.

Linking within the document

Links in the technical documentation wiki need to be checked to make sure they are referring to other parts of the tech doc, or external sources.  Links to pages in the project wiki are “okay” but need to be done carefully -- such links are often red flags that the tech doc is drifting into content better suited for the project wiki.  Links to the archive should be avoided.  Content from the archive that is relevant for the current version should be copied into the documentation wiki.

...