Repository navigation
docs: repair canonical and source links - #89
Merged
Merged
Conversation
Reviewer's guide (collapsed on small PRs)Reviewer's GuideRepairs 10 verified documentation identities: two canonical repository links and eight source/line references, while preserving the pinned Hermes Gate commit and intentionally deferring 23 ambiguous roadmap references. Validation passed for formatting, Ruff, build, Hermes Gate checks, exact-diff acceptance, and repaired link targets; full pytest remains affected by unrelated pre-existing environment/API failures. File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
Contributor
|
Important Review skippedAuto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the ⚙️ Run configuration
You can disable this status message by setting the Use the checkbox below for a quick retry:
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hey - I've found 2 issues
Prompt for AI Agents
Please address the comments from this code review:
## Individual Comments
### Comment 1
<location path="docs/ROADMAP_CODEX.md" line_range="28" />
<code_context>
+Reason: the codebase today cleanly supports the narrow claim that `/recall_hybrid` is an opt-in LongMemEval-derived path and leaves `/recall` untouched ([src/cogito/server.py:175-193](src/cogito/server.py:175), [CHANGELOG.md:3-15](../CHANGELOG.md#L3-L15)). It does **not** yet support the broader dispatcher claim because typed writes, migration, dual-index querying, and valid cross-path merge semantics are missing. Shipping the benchmark result as workload-specific is honest; trying to ship workload-aware dispatch now would be architecture-first, evidence-second.
</code_context>
<issue_to_address>
**Changelog links miss hybrid entry**
When readers follow either changelog link, following either changelog link lands at lines 3–15, which describe the `0.3.0rc1` release rather than the opt-in hybrid path. The hybrid entry is at lines 272–284, so readers see unrelated notes instead of the cited evidence.
Update both changelog anchors to the current `v0.3.0` entry at lines 272–284.
Also at `docs/ROADMAP_CODEX.md:69`.
</issue_to_address>
### Comment 2
<location path="docs/ROADMAP_CODEX.md" line_range="12" />
<code_context>
+- The 400-char split is explicitly unmeasured in the design, and the repo contains no production length-distribution measurement yet ([docs/DISPATCHER_DESIGN.md:56-57](DISPATCHER_DESIGN.md#L56-L57)).
</code_context>
<issue_to_address>
**Markdown line link misses its target**
When a reader follows this link in GitHub's rendered Markdown view, gitHub renders `DISPATCHER_DESIGN.md` as Markdown, where source line numbers are not anchors, so `#L56-L57` does not scroll to the cited text and readers land at the document top.
Link to a rendered heading anchor or use a plain-source URL with the line fragment.
</issue_to_address>Sourcery assessment
Approval pending. 1 finding to address first.
Blocking findings: docs/ROADMAP_CODEX.md:28
| Fast-ship is the right fork. | ||
|
|
||
| Reason: the codebase today cleanly supports the narrow claim that `/recall_hybrid` is an opt-in LongMemEval-derived path and leaves `/recall` untouched ([src/cogito/server.py:175-193](src/cogito/server.py:175), [CHANGELOG.md:3-15](CHANGELOG.md:3)). It does **not** yet support the broader dispatcher claim because typed writes, migration, dual-index querying, and valid cross-path merge semantics are missing. Shipping the benchmark result as workload-specific is honest; trying to ship workload-aware dispatch now would be architecture-first, evidence-second. | ||
| Reason: the codebase today cleanly supports the narrow claim that `/recall_hybrid` is an opt-in LongMemEval-derived path and leaves `/recall` untouched ([src/cogito/server.py:175-193](src/cogito/server.py:175), [CHANGELOG.md:3-15](../CHANGELOG.md#L3-L15)). It does **not** yet support the broader dispatcher claim because typed writes, migration, dual-index querying, and valid cross-path merge semantics are missing. Shipping the benchmark result as workload-specific is honest; trying to ship workload-aware dispatch now would be architecture-first, evidence-second. |
There was a problem hiding this comment.
🟡 Medium · Changelog links miss hybrid entry
When readers follow either changelog link, following either changelog link lands at lines 3–15, which describe the 0.3.0rc1 release rather than the opt-in hybrid path. The hybrid entry is at lines 272–284, so readers see unrelated notes instead of the cited evidence.
Update both changelog anchors to the current v0.3.0 entry at lines 272–284.
Also at docs/ROADMAP_CODEX.md:69.
Prompt for AI agents
In `docs/ROADMAP_CODEX.md` at line 28:
**Changelog links miss hybrid entry**
When readers follow either changelog link, following either changelog link lands at lines 3–15, which describe the `0.3.0rc1` release rather than the opt-in hybrid path. The hybrid entry is at lines 272–284, so readers see unrelated notes instead of the cited evidence.
Update both changelog anchors to the current `v0.3.0` entry at lines 272–284.
Also at `docs/ROADMAP_CODEX.md:69`.| - The proposed default “query both, merge by score” is underspecified. Both paths expose cosine-like scores after stage 1 (`recall_b` rewrites `score` to cosine at [src/cogito/recall_b.py:280-289](src/cogito/recall_b.py:280); hybrid does the same at [src/cogito/recall_hybrid.py:299-316](src/cogito/recall_hybrid.py:299)), but LLM rerank changes order without recomputing score in either path ([src/cogito/recall.py:61-64](src/cogito/recall.py:61), [src/cogito/recall.py:220-227](src/cogito/recall.py:220), [src/cogito/recall_hybrid.py:419-425](src/cogito/recall_hybrid.py:419), [src/cogito/recall_hybrid.py:507-513](src/cogito/recall_hybrid.py:507)). “Merge by score” would therefore be incorrect after reranking. | ||
| - Migration is nontrivial because `seed.py` currently assumes atomized fact writes to `/store` ([src/cogito/seed.py:328-349](src/cogito/seed.py:328)); the design does not define how existing curated facts, `/add`-extracted facts, and future long-form writes are distinguished or backfilled. | ||
| - The 400-char split is explicitly unmeasured in the design, and the repo contains no production length-distribution measurement yet ([docs/DISPATCHER_DESIGN.md:56-57](docs/DISPATCHER_DESIGN.md:56)). | ||
| - The 400-char split is explicitly unmeasured in the design, and the repo contains no production length-distribution measurement yet ([docs/DISPATCHER_DESIGN.md:56-57](DISPATCHER_DESIGN.md#L56-L57)). |
There was a problem hiding this comment.
⚪ Low · Markdown line link misses its target
When a reader follows this link in GitHub's rendered Markdown view, gitHub renders DISPATCHER_DESIGN.md as Markdown, where source line numbers are not anchors, so #L56-L57 does not scroll to the cited text and readers land at the document top.
Link to a rendered heading anchor or use a plain-source URL with the line fragment.
Prompt for AI agents
In `docs/ROADMAP_CODEX.md` at line 12:
**Markdown line link misses its target**
When a reader follows this link in GitHub's rendered Markdown view, gitHub renders `DISPATCHER_DESIGN.md` as Markdown, where source line numbers are not anchors, so `#L56-L57` does not scroll to the cited text and readers land at the document top.
Link to a rendered heading anchor or use a plain-source URL with the line fragment.
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.
Scope
Repairs 10 identity-proven documentation links only:
The remaining 23 stale
src/cogito/*roadmap references are deliberately parked because current source/content drift requires a destination decision rather than a blind namespace rewrite.Verification
git diff --check: passhermes-gate fast: passhermes-gate review: passe2b4609d5d669f2b8f0ca88691b1ced76084b1c7bef049ccaecf6af801a2aa2eroli-lpci/hermes-gate: verifiedFull pytest is explicitly not green:
1280 passed, 44 failed, 1 xfailed, 1 xpassed. The failures are unrelated pre-existing/environment/API failures in live Ollama and mem0/Chroma paths; no tests or scripts consume the three changed Markdown files.Summary by Sourcery
Repair verified canonical and source links across the project documentation without changing code or unresolved roadmap references.
Bug Fixes:
Enhancements:
Documentation: