Each system will have a system-documentation website built with Markdown. This website will be used to track contributions, versions, and documentation. This repo is a template for the system-documentation websites. These repos are named system-documentation.
This template is built using Markdown. Creating and editing these websites will only require a basic understanding of Markdown
Documentation websites will have the following structure:
project
│ README.md
│ index.markdown
│ v1.markdown
│ v2.markdown
│
└── v1
│ │ system-v1-pitch.markdown
│ │ system-v1-pitch.pdf
│ │ system-v1-requirements.markdown
│ │ system-v1-requirements.pdf
│
└── images
| codeadamca.jog
At the bottom of a v<#>.markdown document the contributors are placed in a table including avatar, name, and GitHub link. The avatar images are copied to the students or faculty folder in the repo and resized to 80 x 80 pixels. Image are named <GITHUB_USERNAME>.<ext>. GitHub usernames are converted to lowercase and no punctuation.
The following rules should be followed with each system-documentation website:
- Home page includes a brief system descrition followed by a list of versions
- Each version will have a page named
v<#>.markdownin therootfolder - Each version will have a folder with the original PDF pitch, PDF requirements document, and matching markdown files
- Version files are named
<SYSTEM>-v<#>-pitch.markdown,<SYSTEM>-v<#>-pitch.pdf,<SYSTEM>-v<#>-requirements.markdown, and<SYSTEM>-v<#>-requirements.pdf - Images for the
index.markdown,v<#>.markdown, and version documents are placed in theroot/imagesfolder - Images related to a version are named
v<#>-<TITLE>.<EXT> - Profile images are named
<GITHUB_USERNAME>.<EXT>, images are 80 x 80 pixels and can be png, jpg, or gif, and placed in thestudentsorfacultyfolder
Note
All Markdown should follow the _readme guidelines.
This repo is available to view at
https://brickmmo.github.io/template-documentation-markdown/
