| Summary: | ASTERISK-23749: Wiki Documentation - Create a basic formatting guideline to promote consistency | ||
| Reporter: | Rusty Newton (rnewton) | Labels: | |
| Date Opened: | 2014-05-16 12:09:17 | Date Closed: | 2014-05-27 15:27:53 |
| Priority: | Major | Regression? | |
| Status: | Closed/Complete | Components: | Documentation |
| Versions: | Frequency of Occurrence | ||
| Related Issues: | |||
| Environment: | Attachments: | ||
| Description: | Let's make some simple formatting guidelines for the Asterisk space on wiki.asterisk.org. Then we can be more consistent with our documentation style as we overhaul the wiki.
It should cover at least the following * How to name pages * How to name headings * When and what heading sizes to use * When and how to use a table of contents * When a page should be broken down into multiple smaller pages * When to link words to internal pages and external pages and how to link them * When to use a FAQ * When to use warnings, notes, info bubbles | ||
| Comments: | By: Rusty Newton (rnewton) 2014-05-23 15:50:51.516-0500 Draft here https://wiki.asterisk.org/wiki/display/AST/Wiki+Organization+and+Style+Guide | ||