docs: split reference and policy detail into docs/ - #93
Merged
Merged
Conversation
The README is an overview again (240 to 144 lines). - docs/CLI.md: every build flag and its package.json key. - docs/POLICIES.md: HTML policy, duplicate output paths, the output directory and the symlink modes; they bind the library (Processors, the builders, Frontend) the same as the CLI. - docs/CI_GITHUB_ACTION.md: the composite action's recipes, version pinning and an inputs table; the name leaves room for a GitLab sibling. The library detail stays on docs.rs instead of a fourth Markdown file. The crate docs gain a Features section (the default set, full, lean, and one line per remaining flag), and the live-reload module documents the web-modules:css-reloaded event, the symlink watcher caveat, and a hub-wiring doctest on LiveReload. The README keeps the install block, the --help output, the builders example and the Pages deploy recipe, so the #github-actions anchor and its two in-page links survive. docs/ is not packaged into the crate, same as MAINTENANCE.md.
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
1 participant
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.
The README is an overview again (240 to 144 lines).
The library detail stays on docs.rs instead of a fourth Markdown file. The crate docs gain a Features section (the default set, full, lean, and one line per remaining flag), and the live-reload module documents the web-modules:css-reloaded event, the symlink watcher caveat, and a hub-wiring doctest on LiveReload.
The README keeps the install block, the --help output, the builders example and the Pages deploy recipe, so the #github-actions anchor and its two in-page links survive. docs/ is not packaged into the crate, same as MAINTENANCE.md.