Repository navigation
Read GLOSSARY.md as domain vocabulary and show the analysed languages in About - #32
Conversation
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.
What
GLOSSARY.mdas well asCONTEXT.mdandCONTEXT-MAP.md.CONTEXT.mdand aGLOSSARY.mdin one folder are equally near. A nestedGLOSSARY.mdstill outranks a rootCONTEXT.md.CONTEXT-MAP.mdis its own model, so two files in one folder give two models.GLOSSARY.mdas forCONTEXT.md./api/aboutreturnscodeAnalysis, and the About dialog shows it as a "Code analysis" row after Mode: "TypeScript, TSX and Kotlin. Changes in other languages get no static facts. CodeGraph is used when this repository has a matching index." That sentence and the no-change-facts message are built from the same language table the parsers use.Why
Discovery read only
CONTEXT.mdandCONTEXT-MAP.md, so a repository keeping its vocabulary inGLOSSARY.mdgot no domain maps. Nothing in the app said which languages get static change facts.Decisions and trade-offs
CONTEXT.mdandGLOSSARY.mdare equally nearSYNTAX_LANGUAGESPlease check the nearest-glossary rule at
src/domain-context.ts:102with nested and same-folder glossaries: a binding must fail when its concept cites a shallower file than the nearest one.No ADR was added or amended on this branch.
How to test
Open the settings menu, then About. The last row should read "Code analysis" with the sentence above. Then run a tour with architecture maps on a change to
src/briefing.tsin this repository, which keeps its vocabulary in the rootGLOSSARY.md. When the tour offers a domain map, its terms should citeGLOSSARY.md. Please check by eye that the long Code analysis sentence wraps inside the About dialog.