docs: rewrite as task-oriented usage docs#4
Merged
Conversation
Convert the VitePress site from code-mirroring reference docs into usage documentation, decoupling it from implementation details so it no longer rots when the code changes. - Drop class names/FQCNs, signatures, schemas, internal file paths, and "what it renders" walkthroughs in favor of usage snippets and brief, purpose-described options. - Replace all prop/option tables with clean bold-term lists. - Consolidate repeated concepts into single canonical pages (components overview, asset & init system, JS translations, settings, validator) and link to them instead of repeating across ~40 pages. - Remove leaked developer paths from facebook-pixel and project-structure. - Add a docs style guide (CONTRIBUTING-DOCS.md) and expand the root README with a Documentation section and package overview.
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
2 participants
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.
Convert the VitePress site from code-mirroring reference docs into usage
documentation, decoupling it from implementation details so it no longer
rots when the code changes.
"what it renders" walkthroughs in favor of usage snippets and brief,
purpose-described options.
overview, asset & init system, JS translations, settings, validator)
and link to them instead of repeating across ~40 pages.
with a Documentation section and package overview.