James O. D. Hunt
ce85eb2ccd
docs: Add warnings to doc requirements doc
...
Document how other admonitions such as warnings and hints should be
handled.
Fixes #307 .
Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com >
2018-11-21 10:36:56 +00:00
James O. D. Hunt
e81421a5d1
docs: Remove bang from code block
...
Remove the `!` from the `echo` in the code example in the doc
requirements doc.
The current code is in fact invalid as the shell will try to interpret
the exclamation mark as it is a reserved word. Rather than escaping it
in the example, just remove it.
Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com >
2018-11-21 10:36:56 +00:00
James O. D. Hunt
205c6eaba8
docs: Add missing article
...
Add an article to make the notes section read more naturally in the doc
requirements doc.
Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com >
2018-11-21 10:36:48 +00:00
James O. D. Hunt
e83d658ed3
docs: Don't use backslashes in command blocks
...
Advise authors not to use continuation characters in code blocks.
Fixes #303 .
Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com >
2018-11-19 08:16:53 +00:00
Eric Ernst
12d2049579
Merge pull request #188 from jodh-intel/doc-reqs-filenames
...
docs: Requirements for filenames and commands
2018-07-23 14:59:11 -07:00
James O. D. Hunt
86cde89809
docs: Requirements for filenames and commands
...
Explain how to handle filenames and command names in documentation.
Fixes #187 .
Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com >
2018-07-06 09:35:55 +01:00
James O. D. Hunt
1344bc5f84
docs: Document image requirements
...
Update the documentation requirements on the topic of images.
Fixes #189 .
Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com >
2018-07-06 07:48:08 +01:00
James O. D. Hunt
3af75af484
docs: Add notes to doc requirements
...
Add details to documentation requirements document explaining how we use
and format notes.
Fixes #125 .
Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com >
2018-05-25 09:28:42 +01:00
James O. D. Hunt
928640fe37
docs: Add a doc requirements doc
...
Add a document that explains the expectations for project
documentation.
Fixes #99 .
Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com >
2018-05-23 11:15:49 +01:00
