docs: fix stale test count and broken file paths in README - #33
Open
dsmcewan wants to merge 1 commit into
Open
Conversation
- pytest tests/ -q now reports 191 deterministic tests in two places; the suite currently has 272 passing tests. - The "six layers" section referenced layers/*.py and the adapters bullets referenced adapters/*.py, but both subdirectories only exist nested under convergence/ (convergence/layers/, convergence/adapters/), so those paths didn't resolve from the repo root. - The adapters list omitted convergence/adapters/gemini_llm.py and gemini_cli_llm.py, even though `--model gemini` is a real, working CLI choice and the Layout section already lists Gemini as one of the five supported backends.
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.
Summary
Accuracy-only pass over README.md (no other docs needed changes). Verified against the current codebase by cloning fresh, installing the package, running the test suite, and executing every CLI/Docker/server command the README documents.
Fixed
pytest tests/ -q # 191 deterministic tests(in both the Run section and the Layout tree). Running the suite now shows 272 passed. Updated both occurrences.layers/pattern_detector.py,layers/gap_detector.py,layers/third_party.py,layers/domain_convergence.py,layers/phrase_fragmentation.py,layers/cross_channel.py. There is no top-levellayers/directory — these only exist underconvergence/layers/. Fixed all six references.adapters/anthropic_llm.py,adapters/openai_llm.py,adapters/grok_llm.py,adapters/antigravity_cli_llm.py— corrected toconvergence/adapters/....--model geminiis a real, working CLI choice (confirmed indemo.py), but the detailed adapters list never mentionedconvergence/adapters/gemini_llm.py(API-key backend) orconvergence/adapters/gemini_cli_llm.py(keyless CLI fallback). Added a bullet describing both, matching the existing format.Verified accurate, left unchanged
convergence/convergence-web/convergence-buildcommands,--corpus,--eval,--about,--trick,--chatflags — all executed successfully.CONVERGENCE_HOST,CONVERGENCE_API_KEY,/api/chatgating withX-API-Key) matchDockerfileandweb/server.py.FRAGMENTS.md/INTENT.md/HIERARCHY.mddoc-guard tests (tests/test_fragments_doc.py, etc.) still pass unchanged.docs/ARCHITECTURE.mdis an intentional redirect stub to the rootARCHITECTURE.md; not referenced by README, left as-is.Test plan
pytest tests/ -q— 272 passedpytest tests/test_fragments_doc.py tests/test_intent_doc.py tests/test_hierarchy_doc.py -q— 9 passed (unaffected by this change)convergence --corpus {contractor,grammar,dynamics},--eval,--about,convergence-build,convergence-web(curl'd the served index and/api/chat) to confirm README commands work as described