github/kata-containers
1
0
Fork 1
mirror of https://github.com/kata-containers/kata-containers.git synced 2025-08-11 12:52:23 +00:00
Code Issues Projects Releases Wiki Activity

docs: Add TOC requirement

Browse Source 
State that all documents should contain a table of contents.

Partially fixes: #458.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
This commit is contained in:
James O. D. Hunt 2019-05-08 09:39:39 +01:00
parent dd69931a4c
commit b5931eb0d6
1 changed files with 2 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Documentation-Requirements.md
View File

@ -17,6 +17,8 @@ All documents must:
- Be written in [GitHub Flavored Markdown](https://github.github.com/gfm) format. - Be written in [GitHub Flavored Markdown](https://github.github.com/gfm) format.
- Have a `.md` file extension. - Have a `.md` file extension.
- Include a TOC (table of contents) at the top of the document with links to
all heading sections.
# Notes # Notes