-
Notifications
You must be signed in to change notification settings - Fork 4.5k
Closed
Labels
[Status] In ProgressTracking issues with work in progressTracking issues with work in progress[Type] Build ToolingIssues or PRs related to build toolingIssues or PRs related to build tooling[Type] Code QualityIssues or PRs that relate to code qualityIssues or PRs that relate to code quality[Type] Developer DocumentationDocumentation for developersDocumentation for developers[Type] EnhancementA suggestion for improvement.A suggestion for improvement.
Description
There are a lot of ways we can improve docs tooling to make the docs team more efficient and make our docs better.
Manifest parser
We need a new docs manifest parser/generator! Here's what I'd like to see:
It should usetoc.json
as the source of truth, withmanifest.json
being built as a totally separate/machine-generated artefact.In turn, that means thatmanifest.json
should pull page titles from the markdown, rather than needing to set it in multiple placesIt should be possible to generate documentation (e.g. the data docs) separately from generating the manifest, and this should mean we don't need to generate an intermediateroot-manifest.json
anymoretoc.json
should be extended to provide a wildcard option, so auto-generated docs don't need to be explicitly listed inside the file, and can be included in the correct place inside the handbook outline
Linting
I'd also like to propose the addition of a markdown linter. This is partly to aid the parser, for example to ensure that all docs have an h1 title, but also to improve the consistency of our markdown formatting (consistent heading syntax, line breaks, wrapping, etc.). Right now it varies pretty wildly and having a consistent format would be super valuable.
markdownlint and remark-link seem like the leading candidates. Does anyone have an opinion or experience on either of these?
To be clear I don't want to lint grammar/spelling, just the markdown syntax.
ajitbohra, 0aveRyan and gziolo
Metadata
Metadata
Assignees
Labels
[Status] In ProgressTracking issues with work in progressTracking issues with work in progress[Type] Build ToolingIssues or PRs related to build toolingIssues or PRs related to build tooling[Type] Code QualityIssues or PRs that relate to code qualityIssues or PRs that relate to code quality[Type] Developer DocumentationDocumentation for developersDocumentation for developers[Type] EnhancementA suggestion for improvement.A suggestion for improvement.