docs: restructure documentation into focused topic files#430
Open
lvlcn-t wants to merge 5 commits into
Open
Conversation
Member
|
Why is this a stacked pr into fix/linting-tests? this can just be merged into main no? |
niklastreml
requested changes
May 11, 2026
Split the 781-line monolithic README into a slim landing page and focused docs under docs/. Move auto-generated CLI docs to docs/reference/, consolidate dev guides under docs/dev/, and add per-check documentation under docs/checks/. Also adds .markdownlint-cli2.yaml for consistent markdown linting and AGENTS.md for agentic coding assistant guidelines.
Reformat CHANGELOG.md, CODE_OF_CONDUCT.md, CONTRIBUTING.md, docs/dev/README.md, and docs/ownership-metadata-design.md to comply with markdownlint rules: 80-char line wrapping, dash bullet style, title case headings, and sequential ordered lists. Re-add issue #354 backlink to ownership-metadata-design.md.
Signed-off-by: lvlcn-t <75443136+lvlcn-t@users.noreply.github.com>
Signed-off-by: lvlcn-t <75443136+lvlcn-t@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Motivation
The monolithic 781-line README made it hard to find specific
information and was painful to maintain. This PR splits it into
focused, single-topic documentation files under
docs/.Relates to #391 (review)
Tip
This is a large diff — reviewing commit-by-commit is recommended
for a bit of atomicity. Sorry it's so big!
Changes
Commit 1: restructure documentation
installation.md,configuration.md,checks.md,api.md,observability.mddocs/checks/docs/reference/docs/dev/scripts/gen-docs/gen-docs.gooutput pathchart/values.yaml+chart/README.mdURL references.markdownlint-cli2.yamlandAGENTS.mdCommit 2: fix markdown lint
CHANGELOG.md,CODE_OF_CONDUCT.md,CONTRIBUTING.mdfor lint compliance (80-char wrapping, dash bullets, title case)
docs/dev/README.mdanddocs/ownership-metadata-design.mdNew docs structure
Tests done
npx markdownlint-cli2 "**/*.md")TODO