Repository navigation
docs: index the user guide and lint internal names - #265
Closed
thedancingdeveloper wants to merge 1 commit into
Closed
thedancingdeveloper wants to merge 1 commit into
thedancingdeveloper wants to merge 1 commit into
Conversation
List every current guide page from the README and docs/guide, keep the engineering record under "How it is built", and fail the docs-only CI path when the guide names an estate host, tracker, trial or internal id.
Contributor
Author
|
Closed by oversight: WI-2549 is dogfood work and goes through graft (backlog-1), then the batch PR. It does not land as a direct PR. |
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
docs/guidepage, plusdocs/agents.md, from the README anddocs/guide/README.md.docs/guide/cli.mdis omitted until WI-2543 lands.scripts/check-guide-names.sh.Test plan
scripts/check-guide-names.shpassesWI-1indocs/guide/faq.mdmakes the script exit 1 and name the file and line