Skip to content

(CODUX-117) Document docs setup embedding - #2712

Merged
numnx merged 1 commit into
feature/CODUX-188-auto-embed-docs-setup-agentfrom
task/feature-codux-188-auto-embed-docs-setup-agent-t04-codex-mrcgmhpm
Jul 8, 2026
Merged

(CODUX-117) Document docs setup embedding#2712
numnx merged 1 commit into
feature/CODUX-188-auto-embed-docs-setup-agentfrom
task/feature-codux-188-auto-embed-docs-setup-agent-t04-codex-mrcgmhpm

Conversation

@numnx

@numnx numnx commented Jul 8, 2026

Copy link
Copy Markdown
Collaborator

🧩 Task: Document docs setup embedding

Automated task PR opened by Code UX for T04.

📋 Summary

Sprint: Sprint 188 · Auto Embed docs Setup Agent · Task: T04

Add a Project Setup Agent option to auto-embed relevant repository documentation into the project Knowledge docs library, expose it in dashboard and MCP setup flows, and document the behavior.

🤖 Model & Provider

Provider Codex CLI
Model gpt-5.5

⏱️ Timing

Started 2026-07-08 19:17:26 UTC
Finished 2026-07-08 19:20:42 UTC
Duration 3m 16s

📊 Token Usage

Metric Value
Input tokens 88,653
Cached input tokens 1,011,712
Output tokens 5,283
Total tokens 1,105,648
Invocations 1
Tool calls 26
Active time 2m 50s

Included usage estimate (subscription/local login): $1.11

✅ QA Review

⏳ QA review runs after this PR is opened. Check the task card in the dashboard for the outcome once it lands.

📝 Full Task Prompt
## Objective
Keep the repository documentation current for the new Project Setup Agent Docs embedding option across dashboard and MCP surfaces.

## Scope
- `docs/dashboard/project-initialization.md`
- `docs/dashboard/dashboard-guide.md`
- `docs/mcp/tools-and-contracts.md`
- Verify `docs/index.md` and `docs/SUMMARY.md` do not need changes because no new page is added

## Implementation Requirements
1. Update Project Initialization docs to list `Docs` as a setup artifact, show `docs` in the setup request JSON, and describe that Code UX discovers repository documentation and ingests it into the Knowledge docs library.
2. Document the setup result fields for embedded document IDs and per-file embed errors, including the partial-failure behavior.
3. Update Dashboard Guide setup bullets so Add Project and existing project setup mention the new Docs option and its relationship to the Knowledge page.
4. Update MCP Tools and Contracts setup examples so `manage_projects` and `manage_code_ux` examples include `options.docs`, and note that both nested `setup.options` and normalized setup request shapes are accepted.
5. Mention operational constraints: docs embedding is opt-in, uses existing knowledge ingestion/dedupe/embedding behavior, and individual file failures do not fail the whole setup run.

## Constraints
- Do not add a new docs page unless the existing pages become too long; if a new page is created, it must be linked from both `docs/index.md` and `docs/SUMMARY.md`.
- Do not claim docs are embedded synchronously to ready status; embedding status still follows the existing KnowledgeService model behavior.
- Keep wording user-facing and avoid raw implementation-only phrasing.

## Verification
- Run `pnpm run lint`.
- Run `pnpm run build`.
- Success means documentation accurately reflects the implemented setup request shape, UI behavior, MCP behavior, and result fields.
🌿 Branch Info

Base: feature/CODUX-188-auto-embed-docs-setup-agent
Head: task/feature-codux-188-auto-embed-docs-setup-agent-t04-codex-mrcgmhpm


🤖 Generated by Code UX

@numnx
numnx merged commit 5d818cf into feature/CODUX-188-auto-embed-docs-setup-agent Jul 8, 2026
6 checks passed
@numnx
numnx deleted the task/feature-codux-188-auto-embed-docs-setup-agent-t04-codex-mrcgmhpm branch July 8, 2026 19:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant