Repository navigation
docs: add History user guide and configuration drift gate - #17
Merged
Merged
Conversation
Xuepoo
added
docs
P2
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.
Summary
Adds the canonical user guide for the official History plugin and a docs gate
that keeps the Configuration table in sync with the manifest.
Changes
Overview,Install,Commands,Configuration,Keybindings,Troubleshooting) ahead of the developermaterial.
four declared settings, and the typed
E_HISTORY_*denials.tests/check-docs.mjsandjust docs-check: fail on a missing or extradocumented setting, on type/default drift, and on a wrong user-section
order.
Verification
just checkpasses locally (includesjust docs-check).Priority: P2 | Area: plugin | Labels: docs, P2, area:plugin | Milestone: v0.1.0 | RFC: n/a | Task: n/a (user-facing plugin docs)