github/kata-containers
1
0
Fork 1
mirror of https://github.com/kata-containers/kata-containers.git synced 2025-06-27 15:57:09 +00:00
Code Issues Projects Releases Wiki Activity

Merge pull request #583 from grahamwhaley/20200115_toc_doc

Browse Source 
docs: reqs: add link/recommendation to check-markdown
This commit is contained in:
Julio Montes 2020-01-20 08:43:10 -06:00 committed by GitHub
commit ae6d43470a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
Documentation-Requirements.md
View File

@ -24,7 +24,9 @@ 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 - Include a TOC (table of contents) at the top of the document with links to
all heading sections. all heading sections. We recommend using the
[`kata-check-markdown`](https://github.com/kata-containers/tests/tree/master/cmd/check-markdown)
tool to generate the TOC.
- Be linked to from another document in the same repository. - Be linked to from another document in the same repository.
Although GitHub allows navigation of the entire repository, it should be Although GitHub allows navigation of the entire repository, it should be