From 2b25edddbc494c44ecf993ee8c3429ab6b3c3cfc Mon Sep 17 00:00:00 2001 From: Tim Moore Date: Wed, 13 Feb 2019 20:56:55 -0500 Subject: [PATCH] Update style-guide.md Added missing intro block for documentation articles. Closes Issue #6 --- hugo-site/content/docs/style-guide.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/hugo-site/content/docs/style-guide.md b/hugo-site/content/docs/style-guide.md index 871f7f7..8fde34a 100644 --- a/hugo-site/content/docs/style-guide.md +++ b/hugo-site/content/docs/style-guide.md @@ -1,7 +1,7 @@ +++ title = "Style Guide" menutitle = "Style Guide" -description = "Start Here: Formatting and Quickstart Guide" +description = "Documentation Contributions: Formatting and Quickstart Guide" pre = " " +++ @@ -22,6 +22,15 @@ Trident documentation will be periodically reviewed and edited to conform to thi All documentation is stored as Markdown files in the [trident-website](https://github.com/project-trident/trident-website/tree/master/hugo-site/content) repository on GitHub. These files are published to http://www.project-trident.org as articles. +All articles must begin with a header block with a few specific elements: +``` ++++ +title = "Article Title" +menutitle = "Article title in website sidebar" +description = "Brief description of article. Appears on the website." +pre = " " ++++ +``` Every documentation file needs an introduction section explaining the goal of the document and a summary of the most useful procedure. Trident Basic Style Elements: