Skip to content
This repository
Browse code

Add reference to documentation directory structure

  • Loading branch information...
commit b99c9e8c57774f8a2d356ccdb29dfe1cfc7913a0 1 parent c4b0c0e
Will Rossiter authored September 02, 2012

Showing 1 changed file with 24 additions and 0 deletions. Show diff stats Hide diff stats

  1. 24  docs/en/topics/directory-structure.md
24  docs/en/topics/directory-structure.md
Source Rendered
@@ -51,6 +51,30 @@ Example Forum:
51 51
 
52 52
 ![](_images/modules_folder.jpg)
53 53
 
  54
+### Module documentation
  55
+
  56
+Module developers can bundle developer documentation with their code by producing
  57
+plain text files inside a 'docs' folder located in the module folder. These files
  58
+can be written with the Markdown syntax (See ["Writing Documentation"](/misc/contributing#writing-documentation))
  59
+and include media such as images or videos.
  60
+
  61
+Inside the docs folder, developers should organize the markdown files into each 
  62
+separate language they wish to write documentation for (usually just `en`). Inside 
  63
+each languages' subfolder, developers then have freedom to create whatever structure 
  64
+they wish for organizing the documentation they wish.
  65
+
  66
+Example Forum Documentation:
  67
+
  68
+ | Directory  | Description                                                         | 
  69
+ | ---------  | -----------                                                         | 
  70
+ | `forum/docs` | The docs folder will be picked up by the documentation viewer. | 
  71
+ | `forum/docs/_manifest_exclude` | Empty file to signify that SilverStripe does not need to load classes from this folder |
  72
+ | `forum/docs/en/`       | English documentation  | 
  73
+ | `forum/docs/en/index.md`	| Documentation homepage. Should provide an introduction and links to remaining docs |
  74
+ | `forum/docs/en/installing.md` | |
  75
+ | `forum/docs/en/_images/` | Folder to store any images or media |
  76
+ | `forum/docs/en/sometopic/` | You can organize documentation into nested folders |
  77
+
54 78
 
55 79
 ## PHP Include Paths
56 80
 

0 notes on commit b99c9e8

Please sign in to comment.
Something went wrong with that request. Please try again.