The following guidelines should be followed within the Official Fedora Documentation.
The first version that follows these guidelines is the Fedora 3.5 Documentation.
On this page:
Headings
- Use h1. for top-level headings (major sections).
- Use h2. for subheadings, then h3., and so on.
Callouts
- Use {tip} for tips that suggest a beneficial, but optional action.
- Use {info} for other helpful information.
- Use {note} for warnings of medium importance. If these are not followed, it is possible that the user will experience moderate problems.
- Use {warning} for warnings of high importance. If these are not followed, there it is possible that the user will experience severe problems.
Introductory Text
- Don't have an "Overview" or "Introduction" section. Instead, just start the page with introductory text.
- If a table of contents is present, it should immediately follow the introductory text.
Tables of Contents
- If a page exceeds two sections, it should have a table of contents allowing readers to quickly understand the major sections and jump around, if needed.
- The wiki markup for a page's table of contents should look exactly like this:
*On this page:* {toc}
- If a page is simply a container for other pages (e.g. a "section" of documentation), the body's wiki markup should be exactly this:
*In this section:* {children}