[asterisk-bugs] [JIRA] (ASTERISK-23749) Wiki Documentation - Create a basic formatting guideline to promote consistency

[Rusty Newton (JIRA)]

    [ https://issues.asterisk.org/jira/browse/ASTERISK-23749?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=218432#comment-218432 ] 

Rusty Newton commented on ASTERISK-23749:
-----------------------------------------

Draft here https://wiki.asterisk.org/wiki/display/AST/Wiki+Organization+and+Style+Guide

> Wiki Documentation - Create a basic formatting guideline to promote consistency
> -------------------------------------------------------------------------------
>
>                 Key: ASTERISK-23749
>                 URL: https://issues.asterisk.org/jira/browse/ASTERISK-23749
>             Project: Asterisk
>          Issue Type: Improvement
>      Security Level: None
>          Components: Documentation
>            Reporter: Rusty Newton
>            Assignee: Rusty Newton
>
> 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



--
This message was sent by Atlassian JIRA
(v6.2#6252)