Repository navigation
test: move docs inventory snapshot next to its test - #54
Merged
Merged
Conversation
Documentation_FrozenSurface wrote its generated inventory into the draft-11 plan folder (.agent/plans/2026-09-11-.../docs-surface-map.md), so every docs change had to edit a historical plan document, and a stale-inventory failure gave no hint where the file lived. - Move the generated inventory to tests/AAuth.Tests/Api/DocumentationInventory.snapshot.md, with a header explaining how to regenerate it. Generated content is unchanged. - Make the stale-snapshot failure name the file and the AAUTH_UPDATE_DOCS_INVENTORY=1 regeneration step. - Keep the hand-written draft-11 analysis in docs-surface-map.md and add a dated update callout pointing to the new location. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
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.
Problem
SnippetCompilationTests.Documentation_FrozenSurfacesaves its generated docs inventory (a SHA-256 hash for every inventoried Markdown file and code block) inside a dated plan document:.agent/plans/2026-09-11-aauth-v11-spec-migration/docs-surface-map.md. As a result:Documentation inventory is stale…) doesn't say which file to update or how. docs: fix Mermaid sequence diagrams broken by semicolons #52 hit this and needed docs: regenerate docs surface inventory after Mermaid fixes #53 to fix it.Change
tests/AAuth.Tests/Api/DocumentationInventory.snapshot.mdholds the generated inventory, with a header explaining how to regenerate it. It is three levels below the repo root, like the old file, so the generated../../../links still resolve.tests/isn't inventoried, so the snapshot doesn't hash itself.AAUTH_UPDATE_DOCS_INVENTORY=1step.docs-surface-map.md. Only the generated appendix was removed, and a dated update note points to the new location.The test's behavior is unchanged: same inventory, same checks, same opt-in regeneration.
Validation
dotnet test tests/AAuth.Tests --filter "FullyQualifiedName~SnippetCompilationTests|FullyQualifiedName~DocumentationLinkTests": 108 passed.docs/glossary.mdmakes the test fail with the new message (Documentation inventory snapshot tests/AAuth.Tests/Api/DocumentationInventory.snapshot.md is stale…).