Repository navigation
chore: catch an edit made in only one of the two copies - #104
Merged
Merged
Conversation
Every page exists twice, and Mintlify publishes the root copy, so a correction made under llm-gateway/docs/ alone changes nothing on the site and nothing says so. The coherence check now compares the twins, and a GitHub Action runs it on every pull request.
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.
Why
Every page exists twice:
autofix.mdxat the repo root, which Mintlify publishes, andllm-gateway/docs/autofix.mdx, its dead twin. Correcting the wrong one changes nothing on the site, and nothing warns you.Deleting either set takes the whole site down, so the duplication stays for now. This guards against the trap it creates.
What changed
scripts/check-coherence.mjscompares the twins. It fails when they differ, when a page has no twin, and when a twin has no published root copy.CLAUDE.mdstates which of the two files is published.Check
GREEN on the current tree, 98 pages. Verified it turns RED on a one-sided edit and on a page added without its twin.