Skip to content

Commit

Permalink
wip
Browse files Browse the repository at this point in the history
  • Loading branch information
burnettk committed Jan 6, 2025
1 parent f6f4448 commit cb00681
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions docs/how_to_guides/documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```

0 comments on commit cb00681

Please sign in to comment.