Development

GuidelinesForDocumentationContributors (diff)

You must first sign up to be able to contribute.

Changes between Version 2 and Version 3 of GuidelinesForDocumentationContributors

Show
Ignore:
Author:
nicolas (IP: 82.226.137.29)
Timestamp:
05/20/08 22:39:07 (9 years ago)
Comment:

Moved content

Legend:

Unmodified
Added
Removed
Modified
  • GuidelinesForDocumentationContributors

    v2 v3  
    1 = Guidelines for documentation contributors =  
    2  
    3 Here are a few guidelines for the people interested in contributing to the documentation. 
    4  
    5 == Version == 
    6 The documentation evolves constantly. Before committing your modifications, always update to the latest version by calling: 
    7  
    8 {{{ 
    9 svn update 
    10 }}} 
    11  
    12 ...in your local documentation checkout directory. 
    13  
    14 == Format == 
    15 The documentation files are written using the [http://daringfireball.net/projects/markdown/ Markdown] format. This makes them easy to read as text files, and easy to display them in a browser through simple markdown-to-html converters. 
    16  
    17 This means that when you modify a file of the documentation, you should always check if the Markdown syntax is correct by testing your page in a Markdown [http://www.michelf.com/projects/php-markdown/dingus/ Dingus]. 
    18  
    19 == Style == 
    20 Notice that the documentation never uses ''we'', but prefers referring to the reader rather than the author. Please follow this guideline when writing new paragraphs. 
    21  
    22 All the code chunks, file names, references to objects or other code-related words always have to be declared as code (i.e. enclosed in ticks in the markdown file) 
     1Guidelines for documentation contributors [wiki:HowToContributeToSymfony#writing_documentation have been moved here].