Repository navigation
docs: align 1.0.1 guides with the implemented workflows - #675
Merged
Merged
Conversation
Correct architecture, client guidance, test commands and configuration preservation. Retain historical experiment decisions and identify remaining release verification. Release-As: 1.0.1
Contributor
|
Droid encountered an error —— View job |
Release-As: 1.0.1
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 changes
The 1.0.0 documentation did not clearly distinguish the original demonstration from the live research workflow. This update brings the architecture diagram, ADR index, README, developer instructions, API/CLI/MCP guides, and migration and recovery instructions into line with the completed 1.0.1 fixes.
The guides explain how retained research becomes session evidence, how explicit follow-ups run, what survives a restart, and how to migrate the two vector indexes independently. They also state the limits: uncertain external calls are not silently repeated, time-based evidence checks do not retrieve archived pages, and controlled integration tests do not prove better live-model answers.
The development instructions now use test files that exist and explain that production containers do not ship the test suite. Historical experiment records remain historical.
Validation
Documentation surface checks pass against routes and configuration. CLI coverage checks pass for 52 endpoints (17 exemptions); MCP coverage checks pass for 64 endpoints (59 tools and five exemptions). All 175 relative file links in the changed Markdown resolve. An independent source review found one unsafe configuration-copy instruction, which is corrected.
Implementation acceptance is recorded in the cleanup plan with its tested revisions and CI links. Deployment and release-image verification remain separate requirements; these documentation checks do not establish live-model answer quality.
Release-As: 1.0.1
Implementation base: merged PR #674 at
3f1406970c900ab999b04bb07009c2c16bb2eeeb; both integration suites passed 2,798 tests, with 162 skips and 17 deselections recorded separately. ADR-0070 is accepted on that evidence.