From 4422e314041d00195d9748dba40bac5b92f32f2a Mon Sep 17 00:00:00 2001 From: Andrea Censi Date: Tue, 9 Oct 2018 21:02:46 +0200 Subject: [PATCH] done --- book/duckumentation/00_book_contribute.md | 2 ++ .../10_contributing/00_part_contributing.md | 2 ++ .../20_markduck/00_part_markduck.md | 2 ++ .../20_markduck/65_docs_features.md | 5 +++++ .../30_style_guide/76_style_guide.md | 17 +++++++++++++++++ 5 files changed, 28 insertions(+) diff --git a/book/duckumentation/00_book_contribute.md b/book/duckumentation/00_book_contribute.md index 8197da5..c28f5fb 100644 --- a/book/duckumentation/00_book_contribute.md +++ b/book/duckumentation/00_book_contribute.md @@ -3,3 +3,5 @@ Maintainer: Andrea Censi This book describes the features of our documentation system and the procedures to update it. + + diff --git a/book/duckumentation/10_contributing/00_part_contributing.md b/book/duckumentation/10_contributing/00_part_contributing.md index f10fdc7..d4ebf96 100644 --- a/book/duckumentation/10_contributing/00_part_contributing.md +++ b/book/duckumentation/10_contributing/00_part_contributing.md @@ -1,3 +1,5 @@ # Contributing to the documentation {#part:contribute-to-docs status=ready level=part} This part describes the workflow for contributing to our documentation. + + diff --git a/book/duckumentation/20_markduck/00_part_markduck.md b/book/duckumentation/20_markduck/00_part_markduck.md index a7a33fc..3de6af1 100644 --- a/book/duckumentation/20_markduck/00_part_markduck.md +++ b/book/duckumentation/20_markduck/00_part_markduck.md @@ -1,3 +1,5 @@ # Markduck format {#part:markduck status=ready} This part describes the Markdown dialect that is used in the documentation. + + diff --git a/book/duckumentation/20_markduck/65_docs_features.md b/book/duckumentation/20_markduck/65_docs_features.md index 1fe0ad7..9dc6199 100644 --- a/book/duckumentation/20_markduck/65_docs_features.md +++ b/book/duckumentation/20_markduck/65_docs_features.md @@ -453,6 +453,9 @@ to link to only the name, only the number or both ([](#tab:link-examples)). } + + + ## Comments You can insert comments using the HTML syntax for comments: diff --git a/book/duckumentation/30_style_guide/76_style_guide.md b/book/duckumentation/30_style_guide/76_style_guide.md index 6617b6e..8697659 100644 --- a/book/duckumentation/30_style_guide/76_style_guide.md +++ b/book/duckumentation/30_style_guide/76_style_guide.md @@ -105,6 +105,23 @@ If the command is supposed to be run on both, omit the hostname: $ cd ~/duckietown +For a container: + + container $ echo container + +For a container on a Duckiebot: + + duckiebot-container $ echo container + +For a container on the laptop: + + laptop-container $ echo container + +For a container on a traffic light: + + trafficlight-container $ echo container + + ## Frequently misspelled words - "Duckiebot" is always capitalized.