From 1af686c18dc77c74ac1591f3373629f742826759 Mon Sep 17 00:00:00 2001 From: Graham Whaley Date: Wed, 15 Jan 2020 17:43:28 +0000 Subject: [PATCH] docs: reqs: add link/recommendation to check-markdown Recommend the use of our own check-markdown tool to generate TOCs. Fixes: #582 Signed-off-by: Graham Whaley --- Documentation-Requirements.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/Documentation-Requirements.md b/Documentation-Requirements.md index de863bf7ac..c1cea47a40 100644 --- a/Documentation-Requirements.md +++ b/Documentation-Requirements.md @@ -24,7 +24,9 @@ All documents must: - Be written in [GitHub Flavored Markdown](https://github.github.com/gfm) format. - Have a `.md` file extension. - 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. Although GitHub allows navigation of the entire repository, it should be