Sync dev from Fork - #2514
Merged
Merged
Conversation
Update `docs/reference/cli-commands.md`, `docs/operations/management-cli.md`, `docs-web/developer/management-actions.md`, `docs/index.md`, and `docs/SUMMARY.md` to reflect accurate CLI management behaviors. Add documentation for flag coercion, startup behaviors, and missing aliases. Fix array argument syntax in examples. Update the payload-json approval syntax instructions for destructive commands to reflect standard flag usage. Co-authored-by: numnx <1517214+numnx@users.noreply.github.com>
Update documentation across `docs/` and `docs-web/` to reflect the current Code UX container-first runtime. Changes include: - Removing outdated MCP-only and Jules-only framing from entrypoint docs. - Explicitly separating `src/index.ts` (management), `worker-host` execution, and `electron` desktop shell boundaries. - Documenting that `CodeUxServer` wires backend services. - Mentioning the default dashboard port 4444. Co-authored-by: numnx <1517214+numnx@users.noreply.github.com>
…vior - Updated docs/mcp/tools-and-contracts.md to mention `run_due` accepts an optional `now` override, that memory remediation targets are distinct, and that absolute or `after_sprint_end` scheduling anchors support `offsetMinutes`. - Updated docs-web/developer/management-actions.md to mention `now` ISO date override and that `memory_remediation` targets use dedicated routes. - Updated docs-web/user/dashboard/scheduler.md to add memory remediation target info, and recurrence timing explicitly mentioning minutely and anchor options. - Updated docs/dashboard/scheduler.md to explicitly mention `manage_scheduler` delete requires approval and `run-due` accepts an optional `now` parameter. Co-authored-by: numnx <1517214+numnx@users.noreply.github.com>
Corrected settings resolution cascade docs to clarify that `system` is the base (with built-in defaults folded in) rather than an override over `defaults`. Documented that effective settings API endpoints and dashboard UI expose a `sources` object indicating the origin scope (`system`, `project`, or `sprint`) of each resolved field. Updated delete endpoints to document explicit reset paths. Co-authored-by: numnx <1517214+numnx@users.noreply.github.com>
- Updated `docs-web/user/quicksprints.md` to reflect `QuicksprintTemplateRecord` and the Plan Only vs Plan & Start dashboard flow. - Added REST API and execution payload details (`submitMode`, `taskCount`, `noTaskLimit`, `routeOverride`, `modelOverride`) to `docs/dashboard/quicksprint-templates.md`. - Updated `docs/mcp/tools-and-contracts.md` with explicit fields for `create_template`, `update_template`, `execute`, and `start`. - Removed stale text in `docs-web/user/dashboard/sprints.md` about quicksprints lacking flexibility. Co-authored-by: numnx <1517214+numnx@users.noreply.github.com>
This commit updates documentation files to reflect the current Code UX settings schema and pipeline architecture, including: - Clarified `git.defaultBranch` fallback behaviors. - Added `sprintKeyPrefix`, `sprintBranchScheme`, `featureBranchPrefix`, `autoCreatePr`, and `prDescription` configuration options to documentation. - Documented CLI workflow stages (`prepare`, `execute-provider`, `memory-capture`, `git-finalize`, `pr-finalize`, `cleanup`). - Updated branch token substitution descriptions to match canonical tokens in `branch-name-tokens.ts`. - Updated CI autofix retry descriptions to clarify clamping and VirtualWorkerService behavior. - Addressed stale PR creation / branch resolution texts. Co-authored-by: numnx <1517214+numnx@users.noreply.github.com>
Co-authored-by: numnx <1517214+numnx@users.noreply.github.com>
Co-authored-by: numnx <1517214+numnx@users.noreply.github.com>
…927186261442 docs: sync cli management docs with implementation
docs: clarify settings cascade and source metadata in documentation
…81943 Update scheduler documentation
…361320479104902 docs: sync CLI commands and scripts with package.json
…6914204903 docs: Update quicksprint templates docs for current execution UX and API
…953880660105735573 docs: Update architecture docs to match current runtime entrypoints
…ngs-18445989928925691126 docs: update Git and CLI workflow settings documentation
…cture * Update strategy option ORCHESTRATOR to AGENT * Update provider routing docs to accurately describe provider config ids instead of a single global provider * Detail model override behavior for planning and quicksprints * Clarify exact fallback fields for custom model providers in Qwen and OpenCode docs Co-authored-by: numnx <1517214+numnx@users.noreply.github.com>
…077592670764650 Update provider routing documentation to reflect instance architecture
Updates documentation to clarify the boundary between memory and knowledge: - `manage_memory` handles memory nodes, durable claims/evidence, model status/catalog, map/count, promote, and reembed. - `delete` and `deprecate_claim` require approval confirmation. - `search_knowledge` is a separate MCP tool used for semantic search over knowledge base documents. - Knowledge documents/subscriptions are managed separately via the dashboard and the `search_knowledge` tool. Co-authored-by: numnx <1517214+numnx@users.noreply.github.com>
…ce-audit-2 into docs-mcp-tool-inventory-11285896668018151551
…1856571749777711075 docs: distinguish `search_knowledge` from `manage_memory` claims
…8018151551 docs: update MCP tool inventory and deprecate manage_code_ux
Updated documentation across `docs/mcp/tools-and-contracts.md`, `docs/settings/configuration-and-storage.md`, `docs-web/developer/settings-reference.md`, and `docs-web/developer/management-actions.md` to precisely describe the stateful human confirmation gate for settings mutations. Changes clarify that `replace`, `patch`, and `reset` actions require a two-step confirmation (the second call must use the exact same action and payload plus `approval.confirmed: true` within 15 minutes), while `get` and `resolve` actions are read-only and execute immediately. Expanded JSON patching examples to illustrate the unconfirmed and confirmed sequence. Co-authored-by: numnx <1517214+numnx@users.noreply.github.com>
Updated `docs-web/user/dashboard/settings.md` to match the current category list from `SettingsCategoryRail.tsx`, clarified that sprint scope settings are sparse overrides via the live modal, and documented the new Provider instance cards and Terminal login UI. - Replaced old categories with 01-10 numbered list. - Fixed sprint scope explanation. - Added Provider instances section mentioning Terminal login and Auth modes. - Fixed `AI providers` to `Integrations` in external settings hints section. Co-authored-by: numnx <1517214+numnx@users.noreply.github.com>
- Updated `docs-web/user/dashboard/sprints.md` with missing documentation for Jira, GitHub, and GitLab issue imports. - Updated `docs-web/user/dashboard/sprints.md` to reflect organic cell gallery and sprint ledger bulk actions (e.g. bulk start, pin, delete) based on `design-system-sprints.md`. - Updated `docs-web/user/dashboard/tasks.md` with new status mapping (`QA_REVIEW_FAILED`, `CODING_COMPLETED` for dependencies). - Updated MCP tool mapping for task domains from `manage_code_ux` to `manage_tasks` and `manage_sprints`. Co-authored-by: numnx <1517214+numnx@users.noreply.github.com>
docs: align settings documentation with current dashboard UI
- Update virtual workers architecture docs with setup image caching, isolated credential mounts, and dedicated runtime volumes. - Clarify that host execution mode is a fallback and Docker is strictly required for merge conflict isolation. - Update project runtime integration docs to describe explicit cleanup paths via RuntimeCleanupService and DockerAssetPruneService. - Clarify credential mount boundaries in security-hardening.md. - Expand runbook and troubleshooting docs to cover setup image caches, runtime volumes, and structural distinctions between preview and CLI execution containers. Co-authored-by: numnx <1517214+numnx@users.noreply.github.com>
…5821754051582110 docs: explicitly document settings human confirmation gate
…39039325916846 docs: update Docker workspace and cleanup documentation
- Separates AttentionLedger and LiveConnectionsCard into dedicated components. - Documents InvocationFeedPanel and its restart/cancel capabilities. - Clarifies lean execution payload structure in WebSocket docs. Co-authored-by: numnx <1517214+numnx@users.noreply.github.com>
- Updated agent-preset-foundation.md to use current UI component names (`AgentMemoryConfigPanel`, `AgentKnowledgePanel`, `AgentMcpManageModal`, and `InstructionFileEditorPanel`). - Updated agent-sync-and-planning-agent.md to accurately document `out_of_sync` status checks for memory, avatar, mcp access, and provider configs. - Updated agents.md (docs-web) to include new features: Instruction Files, Knowledge Base, MCP Access, and clarify memory and avatar configurations. Co-authored-by: numnx <1517214+numnx@users.noreply.github.com>
- Replace `mergeProtocol` and `actionRequiredProtocol` with `protocol` in `atomic-loop.md` and `docs-web/user/sprint-orchestration.md`. - Detail correct behavior of QA holding a task in `QA_REVIEW_FAILED` state on exhaustion. - Re-align flowcharts and list steps in sprint loop. Co-authored-by: numnx <1517214+numnx@users.noreply.github.com>
docs: align sprint orchestration behavior with current execution flow
Updates `docs-web/user/dashboard/chat.md` and `docs/architecture/mcp-connections-and-listen-mode.md` to accurately reflect the current Code UX dashboard chat behavior. Replaces the outdated concept of `dashboard_reply` invocation types being the only route mechanism with the explicit routing logic (worker route > virtual provider > live pickup > fallback). Adds documentation on cancelling active thread turns and invocations and the optimistic persistence of failed transcript state with retry actions. Closes #123 Co-authored-by: numnx <1517214+numnx@users.noreply.github.com>
…ocs-release Co-authored-by: numnx <1517214+numnx@users.noreply.github.com>
This commit updates `docs/dashboard/browser-preview.md`, `docs/dashboard/dashboard-guide.md`, and `docs-web/user/dashboard/file-browser.md` to accurately document the File Browser as a distinct dashboard runtime surface. It separates the feature from Browser Preview, details its API routes (`/api/file-browser/*`), and updates the `/files` dashboard navigation entry. Co-authored-by: numnx <1517214+numnx@users.noreply.github.com>
…5720404454849 docs: clarify file browser documentation
- Add `list_execution_invocation_messages` action to `manage_telemetry` docs - Detail `useStatsPageData` usage and Git analytics bounds - Document explicit model pricing caching in stats dashboard - Remove hallucinated references and fix telemetry schema alignment Co-authored-by: numnx <1517214+numnx@users.noreply.github.com>
docs: update chat routing and cancellation behavior
…770019 docs: update telemetry and stats documentation to match codebase
…337209 docs: Clarify canonical documentation source of truth and deprecate docs-release
Updates Code UX documentation to accurately reflect codebase security enforcement. Replaces the sensitive-looking string `your_api_key_here` with `<YOUR_JULES_API_KEY>` to prevent accidental secrets leakage during onboarding. Fixes the incorrect `--mcp-https-auth-token` typo to the correct `--mcp-http-auth-token`. Clarifies that Docker provider execution isolates credentials via specific mounts (e.g. `~/.gemini`, `~/.codex`) instead of broad workspace root access. Adds explicit mention of dashboard security headers (`X-Frame-Options` and `Permissions-Policy`) and their intentional omission for preview host iframes to allow standard hardware interactions inside previews. Co-authored-by: numnx <1517214+numnx@users.noreply.github.com>
…53485370 docs: correct security hardening facts, placeholders, and Docker mounts
This commit systematically replaces legacy terminology across the documentation and the dashboard web index. - Changed "Hosted Jules provider" to "Hosted Code UX provider" in the glossary and `docs-web/index.md`. - Removed legacy artifacts (`.jules-subagents`) from path references and explicitly marked them as legacy. - Provided clear glossary definitions for core concepts: Quicksprint, Scheduler, Memory, Knowledge, and Preview container. - Updated the CLI flag link in `docs/getting-started/quickstart.md` to point correctly to the CLI Commands Reference. - Aligned `docs/SUMMARY.md` navigation links with the actual documentation directory structure. Co-authored-by: numnx <1517214+numnx@users.noreply.github.com>
…27835836503569264 docs: align Code UX terminology and fix navigation links
- Normalized `pnpm run ci` documentation across instruction files to reflect the exact `lint -> test:backend:coverage -> test:dashboard -> build` sequence. - Re-clarified the `pnpm run dev` script behavior in building-from-source to denote the side-by-side backend/dashboard start. - Updated `GEMINI.md`, `CLAUDE.md`, and `AGENTS.md` to precisely denote that the target `origin` is the `numnx/codeux` fork and `upstream` is `codeux-ai/codeux`. - Asserted docs-web mirror policy explicitly in `README.md` and `docs/development/documentation-standards.md` avoiding the forbidden `docs-release/`. Co-authored-by: numnx <1517214+numnx@users.noreply.github.com>
…ce-audit-2 into fix/docs-consistency-7639111637287380126
…380126 docs: align developer instructions and CI sequences across documentation
This commit removes stale references to deprecated manage_code_ux usages and .jules-subagents directory configuration in the web documentation to match the canonical state in docs/. Co-authored-by: numnx <1517214+numnx@users.noreply.github.com>
docs: mirror canonical documentation behavior to docs-web
…vices
- Updated `/health` and `/ready` documentation to accurately reflect `{"status":"UP"}` and `components` behavior in `docs-web/developer/http-api.md`, `docs-web/architecture/mcp-server.md`, `docs-web/user/mcp-clients.md`, and `docs/operations/runbook.md`.
- Documented specific sanitization behavior of `sanitizeInvocationOutputText` without claiming broad unproven redaction in `docs/operations/security-hardening.md`.
- Replaced ambiguous recovery steps with correct canonical service names (`RuntimeStartupRecoveryService`, `RuntimeCleanupService`, `DockerRuntimePruneService`, `DockerAssetPruneService`, `DatabaseMaintenanceService`, and `HeartbeatService`) in `docs/operations/runbook.md` and `docs-web/user/troubleshooting.md`.
- Ensured no overstated claims of external alerting or SLO monitoring exist in the operational documentation.
- Included explicit warnings against manual untargeted Docker removals.
Co-authored-by: numnx <1517214+numnx@users.noreply.github.com>
…385504900 Align operational documentation for endpoints, sanitization, and recovery
…tion flow - Add missing `pnpm run dev:server-only` to README source-run section. - Update `docs-web/architecture/system-overview.md` orchestration flow diagram to reflect that `manage_code_ux` is deprecated in favor of grouped management tools like `manage_sprints:start`. - Update `docs/architecture/system-overview.md` to mention grouped tools and note the deprecation of `manage_code_ux` in the high-level data flow description. - Update `docs-web/user/sprint-orchestration.md` to reference `manage_sprints` instead of `manage_code_ux`. Co-authored-by: numnx <1517214+numnx@users.noreply.github.com>
docs: synchronize documentation for source-run commands and orchestration flow
Updates the `docs-web` documentation to replace active references of `manage_code_ux` with their respective grouped management tools (e.g., `manage_projects`, `manage_tasks`, `manage_settings`, `manage_telemetry`). Leaves `manage_code_ux` only where explicitly documented as a deprecated compatibility tool. Co-authored-by: numnx <1517214+numnx@users.noreply.github.com>
…nces-2523095528712083803 docs(web): deprecate manage_code_ux in favor of grouped management tools
…developer-surface-audit-2 Sprint 44: QS: Documentation & Developer Surface Audit — merge feature/CODUX-44-qs-documentation-developer-surface-audit-2 into dev
Merged
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.
🚀 Sprint Completion: Sprint 44 · QS: Documentation & Developer Surface Audit
📋 Summary
Sprint: Sprint 44 · QS: Documentation & Developer Surface Audit Tasks: 32/32 completed
🧭 Planning
gpt-5.5Included usage estimate (subscription/local login): $1.07
🎯 Original Sprint Prompt
Audit and update Code UX canonical docs and public mirrors so command references, architecture descriptions, MCP/tool contracts, dashboard behavior, operations, settings, workflow guidance, terminology, links, and examples match the current TypeScript runtime and dashboard implementation.
✅ Task Checklist
jules(PR)jules(PR)jules(PR)jules(PR)jules(PR)jules(PR)jules(PR)jules(PR)jules(PR)jules(PR)jules(PR)jules(PR)jules(PR)jules(PR)jules(PR)jules(PR)jules(PR)jules(PR)jules(PR)jules(PR)jules(PR)jules(PR)jules(PR)jules(PR)jules(PR)jules(PR)jules(PR)julesjules(PR)jules(PR)jules(PR)jules(PR)👥 Provider Breakdown
32 by jules
⏱️ Sprint Timing
📊 Aggregate CLI Token Usage
Included usage estimate (subscription/local login): $2.73
🕵️ QA Review Summary
Outcome: pass
Canonical docs, docs-web mirrors, and command/tool references are aligned with the current manifest and source; no blocking drift found.
🌿 Branch Info
Base:
devHead:
feature/CODUX-44-qs-documentation-developer-surface-audit-2🤖 Generated by Code UX