Closed Mrt134 closed 5 years ago
Working outline:
Title: Project Trident Documentation Style Guide
I. Introduction
A. Goal of document
1. License & copyright
2. Single document to govern Trident documentation guidelines.
3. Encourage contribution (organisation sets you free)
B. Quick-start summary
1. Adding markdown document to repo with a PR
2. Review process overview
3. Contribute translation
II. Documentation Tools and Publishing Process
A. Documentation tools
1. Hugo Static Site generator (Link)
2. Markdown text (Link)
3. Recommended editors or other tools (Kate, Geny, Igor, Markdown Magic, etc)
B. Publish process
1. Project Trident documentation files on GitHub
2. Adding an article
3. Build testing and automatic website refresh
4. Statement of edit - contributions might be edited to conform to these style guidelines
III. Style and Usage
A. General Document standards
1. Date/time update
2. Introduction section including goal of document and a quick start summary of the article (tl;dr)
3. Voice and tone of the document
4. Language
B. Images & Tables
1. Image standard usage and storage location
2. Table standard syntax & practice
C. Text style
1. Punctuation
2. Compound words
3. Names and titles
4. Abbreviations
5. Numbers
6. Quotations
D. Markdown Syntax
1. Standard syntax usage
2. Custom syntax usage
IV. Translations
1. Translation file location
2. Translation tools
3. Translation PR process
There are a few updates needed to the initial style guide:
trident-website/hugo-site/content/docs/
directory for this and other guides.+++
title = "Style Guide"
menutitle = "Style Guide"
description = "Start Here: Formatting and Quickstart Guide"
pre = "<i class='fa fa-font'></i> "
+++
block at the beginning of each document.
Update this message with needed changes to the style guide.
Create an outline and write a full document describing all style elements for Project Trident documentation.