Versions Compared

Key

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

...

When linking, don't link to a section number within the document. The section numbers are not available in the wiki pages, and a small change to the structure of the document could make the section numbers incorrect in the PDF.

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.

End with a Children Display macro

...