Detect guide/ and guides/ as documentation directories - #12
Merged
Conversation
wasm-bindgen keeps its documentation as an mdBook under guide/ — the established convention in the Rust ecosystem — yet scored 0/25 on the Documentation directory criterion, which its maintainer pointed out after merging the badge PR. Widen DOC_DIR_NAMES the same way documentation/ and wiki/ were added before. Closes #11
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.
Closes #11.
wasm-bindgen's maintainer reported (wasm-bindgen/wasm-bindgen#5291, comment) that the report claims the repository has no documentation directory while a full mdBook lives under
guide/.DOC_DIR_NAMESonly matcheddoc,docs,documentationandwiki.collect.py: addguideandguidestoDOC_DIR_NAMES— the same widening that addeddocumentation/andwiki/(workspace#24).docs/report-schema.md: the documented name list follows.tests/test_signals.py: the alias test covers the two new names.METRICS_VERSIONchange — affected repositories pick the signal up at their next rescan).