Overhaul Netsuke CLI documentation contract#302
Conversation
Add a draft ExecPlan for the pre-0.1.0 overhaul of Netsuke's CLI design documents and roadmap. The plan records the canonical command surface, JSON result contract, mutation boundaries, agent-consistent vocabulary, and phased follow-up work needed to turn the current documentation into a coherent product direction. Capture validation evidence and the current repo-wide Markdown formatting blocker so reviewers can distinguish this plan from pre-existing documentation lint debt.
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
|
Important Review skippedDraft detected. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Organization UI Review profile: ASSERTIVE Plan: Pro Plus Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
![codescene-delta-analysis[bot]](https://avatars.githubusercontent.com/in/53921?s=60&v=4){kind=small}
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
Update the draft ExecPlan so the planned Netsuke roadmap and design work depends on OrthoConfig's shared agent-native command-contract roadmap instead of duplicating it locally. Record the OrthoConfig task dependencies for context generation, vocabulary policy, JSON stream metadata, profiles, delivery, feedback, and execution ledgers. Also require the future roadmap rewrite to preserve existing Netsuke planned and completed work unless a relevance audit shows that the redesigned UI makes it obsolete.
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
Move completed roadmap work into an archive that preserves the original task text and relevance assessment instead of compressing historical work into broad strategy items. Keep unfinished conditional, accessibility, configuration, graph, CI, and formal-verification tasks live under their existing numbers. Add the agent-consistent CLI and compounding-feature work with explicit OrthoConfig dependencies so Netsuke does not duplicate shared machinery.
Update the active overhaul ExecPlan after pushing the roadmap-fidelity revision so the living plan reflects the current branch state.
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
1 participant
Summary
This branch carries the pre-implementation planning work for Netsuke's
pre-0.1.0 CLI and documentation overhaul. It keeps the product direction
friendly for humans while making the command grammar, output contract,
mutation boundaries, introspection, profiles, run history, delivery, and
feedback predictable for automation and agents.
The latest revision applies the roadmap-fidelity review requested after the
initial PR. Completed historical work now lives in an archive with the exact
completed task text and relevance assessments. The active roadmap now tracks
unfinished and future work only, keeps partial and planned historical tasks
under their existing numbers, restores the detailed
3.14and Phase 4workloads, and states explicit OrthoConfig task dependencies wherever shared
command/configuration/schema machinery belongs upstream.
Execplan: docs/execplans/netsuke-cli-overhaul.md
Roadmap: docs/roadmap.md
Archive: docs/archive/roadmap-completed-foundations.md
Roadmap task: none yet. The plan proposes the new CLI-redesign work under
3.15and compounding agent-consistent features under Phase 5.Review walkthrough
3.14work, preserved Phase 4 tasks, and new3.15/Phase 5 planning.Validation
markdownlint-cli2 docs/roadmap.md docs/archive/roadmap-completed-foundations.md docs/contents.md docs/execplans/netsuke-cli-overhaul.md: passed with 0 errors.make markdownlint: passed with 0 errors.make nixie: passed; all Mermaid diagrams validated successfully.make check-fmt: passed.git diff --check: passed.make fmt: failed insidemdformat-allbecause that helper invokes a differentmarkdownlintbinary that reports pre-existing repository-wide line-length and table findings. Unrelated formatter churn was restored; the branch-owned files pass the project Markdown gate above.Notes
This draft PR still carries planning work, not implementation of the CLI
overhaul. The roadmap revision intentionally avoids deleting completed history
or duplicating OrthoConfig-owned generic machinery.