SOF-7992: docs agent implementation and platform-actions plans - #390
Closed
timurbazhirov wants to merge 1 commit into
Closed
SOF-7992: docs agent implementation and platform-actions plans#390timurbazhirov wants to merge 1 commit into
timurbazhirov wants to merge 1 commit into
Conversation
Adds two planning documents and consolidates the vocabulary across the set: - docs-agent-implementation.md: the execution plan tying the strategy and architecture plans together. Defines the shared phase numbering (0-5), milestones M1-M8 with acceptance criteria, and a decision register. - docs-agent-platform-actions.md: Phase 5, letting the agent execute actions in the user's platform session. The action vocabulary is the Cypress/Gherkin step catalog, so the agent can only do what the test suite proves works. Naming is unified: "the platform" is platform.mat3ra.com (repository `web-app`), and docs-agent-web-app.md is renamed to docs-agent-web-delivery.md, which describes browser delivery of the documentation agent and was easily confused with the platform repository. Records two decisions taken since the plans were written: the agent core now lives in the documentation-agent repository rather than scripts/rag (D6), and the model backend is a provider abstraction defaulting to Gemini with Claude selectable (D5). scripts/rag is marked superseded accordingly. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Member
Author
|
Closed automatically when the head branch was renamed to |
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.
Part of SOF-7992.
Stacked on
feat/agent-rag(PR #389) becauseplans/only exists on that branch — this keeps the diff limited to the new work.What this adds
plans/docs-agent-implementation.mdplans/docs-agent-platform-actions.mdNaming consolidation
"The platform" is platform.mat3ra.com, whose repository is
web-app— one vocabulary across all four documents.docs-agent-web-app.mdis renamed todocs-agent-web-delivery.md: it describes browser delivery of the documentation agent and read as though it were about the platform repository.Phase numbering is now shared by every plan and defined once in the implementation plan §3, so "Phase 2" means the same thing everywhere. Within-milestone steps are "stages" (M8.1–M8.3, A1–A4) to keep the word "phase" unambiguous.
Platform actions, in brief
The agent's action vocabulary is the existing Cypress/Gherkin step catalog, building on the working prototype in web-app#2894. Two consequences: the agent can only do what the E2E suite proves works, and adding a capability means writing the tests first. Steps execute in-page in the user's own session (no credential delegation), gated on OIDC identity, with destructive and billing steps blocked in v1.
Decisions recorded since the plans were written
documentation-agentrepository, notscripts/rag/. One repository owns all agent code; ingestion reads a documentation checkout at a pinned commit.scripts/rag/is marked superseded.mat3ra-documentationwith a $100/month budget and spend cap.Notes
These are internal planning documents. The MkDocs builds only read
lang/en/docs/, so nothing here reaches docs.mat3ra.com.🤖 Generated with Claude Code