From cb00681e89e9113509e39e4b8c532ec8f495561c Mon Sep 17 00:00:00 2001 From: burnettk Date: Mon, 6 Jan 2025 15:12:52 -0500 Subject: [PATCH] wip --- docs/how_to_guides/documentation.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/how_to_guides/documentation.md b/docs/how_to_guides/documentation.md index c350104f2..3e9fdfe67 100644 --- a/docs/how_to_guides/documentation.md +++ b/docs/how_to_guides/documentation.md @@ -151,5 +151,11 @@ We may decide to check the documentation with a "linter" which is designed to ke One option is [markdownlint-cli](https://github.com/igorshubovych/markdownlint-cli), which uses David Anson's [NodeJS-based markdownlint](https://github.com/DavidAnson/markdownlint), which these days seems to be more popular than the [ruby-based markdownlint](https://github.com/markdownlint/markdownlint). A `.markdownlint.jsonc` file has been added that configures the same markdownlint program (basically to ignore the rule about long lines, since we are using ventilated prose). +## Doc Philosphy + +We try to use [Diátaxis](https://diataxis.fr/). +This is also highly related: https://docsfordevelopers.com/ + ```{tags} tutorial + ```