Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Add reference to documentation directory structure

  • Loading branch information...
commit b99c9e8c57774f8a2d356ccdb29dfe1cfc7913a0 1 parent c4b0c0e
@wilr wilr authored
Showing with 24 additions and 0 deletions.
  1. +24 −0 docs/en/topics/directory-structure.md
View
24 docs/en/topics/directory-structure.md
@@ -51,6 +51,30 @@ Example Forum:
![](_images/modules_folder.jpg)
+### Module documentation
+
+Module developers can bundle developer documentation with their code by producing
+plain text files inside a 'docs' folder located in the module folder. These files
+can be written with the Markdown syntax (See ["Writing Documentation"](/misc/contributing#writing-documentation))
+and include media such as images or videos.
+
+Inside the docs folder, developers should organize the markdown files into each
+separate language they wish to write documentation for (usually just `en`). Inside
+each languages' subfolder, developers then have freedom to create whatever structure
+they wish for organizing the documentation they wish.
+
+Example Forum Documentation:
+
+ | Directory | Description |
+ | --------- | ----------- |
+ | `forum/docs` | The docs folder will be picked up by the documentation viewer. |
+ | `forum/docs/_manifest_exclude` | Empty file to signify that SilverStripe does not need to load classes from this folder |
+ | `forum/docs/en/` | English documentation |
+ | `forum/docs/en/index.md` | Documentation homepage. Should provide an introduction and links to remaining docs |
+ | `forum/docs/en/installing.md` | |
+ | `forum/docs/en/_images/` | Folder to store any images or media |
+ | `forum/docs/en/sometopic/` | You can organize documentation into nested folders |
+
## PHP Include Paths
Please sign in to comment.
Something went wrong with that request. Please try again.