roadmodel 0.2.45__tar.gz → 0.2.46__tar.gz

{roadmodel-0.2.45 → roadmodel-0.2.46}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: roadmodel
-Version: 0.2.45
+Version: 0.2.46
 Summary: BYO-key CLI that recommends the right AI model, platform, and settings for a prompt.
 Project-URL: Homepage, https://roadmodel.ai
 Project-URL: Repository, https://github.com/nathanramoscfa/roadmodel
@@ -288,11 +288,12 @@ picks the model. The loop is the same in every repo, in every
 language, on every machine where the commands are installed:
 
 ```
-/roadmap-project        ROADMAP.md — phases, acceptance criteria, and
-                        the security / release / operations strategy
-/roadmap-phase 1        docs/phase01-roadmap.md — Phase 1 broken into
-                        steps; each names its branch, its model and
-                        settings, and carries a <task> prompt
+/roadmap-project        docs/roadmap/ROADMAP.md — phases, acceptance
+                        criteria, and the security / release /
+                        operations strategy
+/roadmap-phase 1        docs/roadmap/phase01-roadmap.md — Phase 1
+                        broken into steps; each names its branch, its
+                        model and settings, and carries a <task> prompt
 /roadmap-step 1 1       a NEW chat runs Step 1: branch → work → PR →
 /roadmap-step 1 2       merge → "Step 1 is complete." One step per
 …                       conversation; no work straddles two steps

{roadmodel-0.2.45 → roadmodel-0.2.46}/README.md

@@ -38,11 +38,12 @@ picks the model. The loop is the same in every repo, in every
 language, on every machine where the commands are installed:
 
 ```
-/roadmap-project        ROADMAP.md — phases, acceptance criteria, and
-                        the security / release / operations strategy
-/roadmap-phase 1        docs/phase01-roadmap.md — Phase 1 broken into
-                        steps; each names its branch, its model and
-                        settings, and carries a <task> prompt
+/roadmap-project        docs/roadmap/ROADMAP.md — phases, acceptance
+                        criteria, and the security / release /
+                        operations strategy
+/roadmap-phase 1        docs/roadmap/phase01-roadmap.md — Phase 1
+                        broken into steps; each names its branch, its
+                        model and settings, and carries a <task> prompt
 /roadmap-step 1 1       a NEW chat runs Step 1: branch → work → PR →
 /roadmap-step 1 2       merge → "Step 1 is complete." One step per
 …                       conversation; no work straddles two steps

{roadmodel-0.2.45/roadmodel/data → roadmodel-0.2.46/docs/templates}/phase-roadmap-template.md

@@ -19,6 +19,12 @@ WHEN TO USE
   - Numbering convention: `phaseNN-roadmap.md` where NN is
     the phase number (e.g. `phase31-roadmap.md` for
     Phase 31, `phase04-roadmap.md` for Phase 4).
+  - Location: `docs/roadmap/`, beside the project's
+    `ROADMAP.md` — every roadmap in one folder. A project
+    that keeps its roadmaps git-excluded (e.g. `private/`)
+    keeps them there. Relative links resolve from
+    `docs/roadmap/` (`../phase{{N}}-qa-findings.md`,
+    `../../scripts/…`).
 
 PLACEHOLDER SYNTAX
   - Prose placeholders use {{double-curly}} form so that
@@ -1444,9 +1450,9 @@ that surface has neither dial.
         executable.
     {{last-2}}. docs/phase{{N}}-qa-
         findings.md exists.
-    {{last-1}}. docs/phase{{N}}-
-        roadmap.md exists (this
-        doc).
+    {{last-1}}. docs/roadmap/
+        phase{{N}}-roadmap.md
+        exists (this doc).
     {{last}}. .github/workflows/
         phase-verify.yml matrix
         includes `{{N}}`.
@@ -1644,9 +1650,9 @@ that surface has neither dial.
     <requirement>
       Mark the phase complete in
       the parent project roadmap
-      (docs/ROADMAP.md, or
-      wherever this project keeps
-      it) in the SAME Stage-3
+      (docs/roadmap/ROADMAP.md,
+      beside this file) in the
+      SAME Stage-3
       commit that marks this step
       (Status rule):
       - `### Phase {{N}}` gets
@@ -2029,7 +2035,7 @@ Each item is one bullet, two sentences max. Lead with the
 deferred thing, follow with where / when it lives instead.
 -->
 
-Per [`docs/ROADMAP.md`](ROADMAP.md) Phase {{N}} "Not in
+Per [`docs/roadmap/ROADMAP.md`](ROADMAP.md) Phase {{N}} "Not in
 scope":
 
 - Item explicitly deferred by the parent roadmap, with a
@@ -2092,9 +2098,9 @@ Example skeleton:
   QA findings rollup, and any tests that need re-running.}}
 
   Audit cross-reference: see
-  [`docs/phase{{N}}-website-audit.md`](phase{{N}}-website-audit.md)
+  [`docs/phase{{N}}-website-audit.md`](../phase{{N}}-website-audit.md)
   finding `PHASE{{N}}-AUDIT-NNN`. QA cross-reference: see
-  [`docs/phase{{N}}-qa-findings.md`](phase{{N}}-qa-findings.md)
+  [`docs/phase{{N}}-qa-findings.md`](../phase{{N}}-qa-findings.md)
   § "{{Back-patch rollup heading}}".
 =============================================================
 -->

{roadmodel-0.2.45/roadmodel/data → roadmodel-0.2.46/docs/templates}/planning-kit-how-to-use.md

@@ -15,8 +15,8 @@ paid API.
 | `model-tier-cost-scale.md` | Per-token **prices** and **subscription tiers** — the funding/cost data the selector's access-selection step consumes. |
 | `settings-display.md` | The **display contract**: how the selector's setting fields map to the real controls each surface exposes (which dials to show, which to omit). Read it before writing any Settings table. |
 | `user-context.md` | The operator's **subscriptions + API keys + platform preference order** — decides *which platform pays* for each pick. |
-| `templates/project-roadmap-template.md` | Skeleton for a whole-project `ROADMAP.md`. |
-| `templates/phase-roadmap-template.md` | Skeleton for one `phaseNN-roadmap.md`. |
+| `templates/project-roadmap-template.md` | Skeleton for a whole-project `docs/roadmap/ROADMAP.md`. |
+| `templates/phase-roadmap-template.md` | Skeleton for one `docs/roadmap/phaseNN-roadmap.md`, beside it. |
 | `prompts/project-roadmap.md` | **Fill-in paste-prompt** that writes `ROADMAP.md` from the project template — refreshes the kit first. |
 | `prompts/phase-roadmap.md` | **Fill-in paste-prompt** that writes one `phaseNN-roadmap.md` — refreshes the kit first. |
 

{roadmodel-0.2.45 → roadmodel-0.2.46}/docs/templates/project-roadmap-template.md

@@ -22,6 +22,12 @@ STYLE RULES (the AI MUST follow)
     a per-phase exit gate, never a final-phase afterthought —
     an issue introduced in Phase 2 must be caught in Phase 2,
     before its work is committed, pushed, or merged.
+  - This file lives at `docs/roadmap/ROADMAP.md`, and every
+    phase roadmap (`phaseNN-roadmap.md`) is written beside it:
+    all roadmaps in one folder, none at the repo root. A
+    project that keeps its roadmaps git-excluded (e.g.
+    `private/`) keeps them there. Relative links resolve from
+    `docs/roadmap/` (`../../README.md`, `../ci.md`).
   - Every phase carries a one-line metadata badge:
       **Complexity:** … · **Risk:** … · **Cloud cost:** … ·
       **Handles sensitive data:** <Yes/No — PII, secrets, auth>

{roadmodel-0.2.45/roadmodel/data → roadmodel-0.2.46/docs/templates}/prompt-phase-roadmap.md

@@ -6,12 +6,12 @@ into a **new** chat in the project and submit. Defaults are shown
 for every placeholder; delete a bracketed line if it does not
 apply.
 
-| Placeholder          | Meaning                                   | Default                            |
-| -------------------- | ----------------------------------------- | ---------------------------------- |
-| `{{N}}`              | Phase number (two digits in filenames)    | —                                  |
-| `{{PROJECT_ROADMAP}}` | The parent project roadmap                | `@ROADMAP.md`                      |
-| `{{OUTPUT}}`         | Where the phase roadmap is written        | `docs/phase{{NN}}-roadmap.md`      |
-| `{{PRIOR}}`          | Previous phase roadmap(s), for continuity | `@docs/phase{{NN-1}}-roadmap.md`   |
+| Placeholder          | Meaning                                   | Default                                    |
+| -------------------- | ----------------------------------------- | ------------------------------------------ |
+| `{{N}}`              | Phase number (two digits in filenames)    | —                                          |
+| `{{PROJECT_ROADMAP}}` | The parent project roadmap                | `@docs/roadmap/ROADMAP.md`                 |
+| `{{OUTPUT}}`         | Where the phase roadmap is written        | `docs/roadmap/phase{{NN}}-roadmap.md`      |
+| `{{PRIOR}}`          | Previous phase roadmap(s), for continuity | `@docs/roadmap/phase{{NN-1}}-roadmap.md`   |
 
 ---
 
@@ -31,6 +31,16 @@ line, a step's Status line sits after its `**Deploys:**` line, or its
 Settings tables have no `Backup` row, STOP
 and tell me the kit is stale — do not write the roadmap from it.
 
+Step 0b — roadmaps live in `docs/roadmap/`: `ROADMAP.md` and every
+`phaseNN-roadmap.md`, together. A project that keeps them git-excluded
+(e.g. `private/`) keeps them there, and the rest of this step does not
+apply: a tracked `ROADMAP.md` beside them is a published copy.
+Otherwise, if this project has a `ROADMAP.md` or `phaseNN-roadmap.md`
+anywhere else that git does not ignore (committed, or written and not
+yet committed), STOP and tell me to run `/roadmap-refresh` first: it
+moves them into `docs/roadmap/` and updates every reference to them. Do
+not write a new roadmap beside them.
+
 Step 1 — write `{{OUTPUT}}` from
 `@planning/templates/phase-roadmap-template.md`, expanding the
 Phase {{N}} section of `{{PROJECT_ROADMAP}}` into an executable plan.

{roadmodel-0.2.45/roadmodel/data → roadmodel-0.2.46/docs/templates}/prompt-project-roadmap.md

@@ -9,7 +9,7 @@ apply.
 | Placeholder    | Meaning                                                  | Default                     |
 | -------------- | -------------------------------------------------------- | --------------------------- |
 | `{{BRIEF}}`    | Where the project is described: files, or inline prose   | `@README.md`                |
-| `{{OUTPUT}}`   | Where the roadmap is written                             | `ROADMAP.md`                |
+| `{{OUTPUT}}`   | Where the roadmap is written                             | `docs/roadmap/ROADMAP.md`   |
 | `{{CONSTRAINTS}}` | Hard constraints the roadmap must respect (optional)  | —                           |
 
 ---
@@ -29,6 +29,16 @@ completion line, or a `### Phase` section's `**Status:**` line sits
 after its **Goal:** rather than directly under its heading, STOP and
 tell me the kit is stale — do not write the roadmap from it.
 
+Step 0b — roadmaps live in `docs/roadmap/`: `ROADMAP.md` and every
+`phaseNN-roadmap.md`, together. A project that keeps them git-excluded
+(e.g. `private/`) keeps them there, and the rest of this step does not
+apply: a tracked `ROADMAP.md` beside them is a published copy.
+Otherwise, if this project has a `ROADMAP.md` or `phaseNN-roadmap.md`
+anywhere else that git does not ignore (committed, or written and not
+yet committed), STOP and tell me to run `/roadmap-refresh` first: it
+moves them into `docs/roadmap/` and updates every reference to them. Do
+not write a new roadmap beside them.
+
 Step 1 — write `{{OUTPUT}}` from
 `@planning/templates/project-roadmap-template.md`. The project brief
 is {{BRIEF}}. [Hard constraints: {{CONSTRAINTS}}.] Read the codebase

{roadmodel-0.2.45 → roadmodel-0.2.46}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "roadmodel"
-version = "0.2.45"
+version = "0.2.46"
 description = "BYO-key CLI that recommends the right AI model, platform, and settings for a prompt."
 readme = "README.md"
 requires-python = ">=3.11"

{roadmodel-0.2.45/docs/templates → roadmodel-0.2.46/roadmodel/data}/phase-roadmap-template.md

@@ -19,6 +19,12 @@ WHEN TO USE
   - Numbering convention: `phaseNN-roadmap.md` where NN is
     the phase number (e.g. `phase31-roadmap.md` for
     Phase 31, `phase04-roadmap.md` for Phase 4).
+  - Location: `docs/roadmap/`, beside the project's
+    `ROADMAP.md` — every roadmap in one folder. A project
+    that keeps its roadmaps git-excluded (e.g. `private/`)
+    keeps them there. Relative links resolve from
+    `docs/roadmap/` (`../phase{{N}}-qa-findings.md`,
+    `../../scripts/…`).
 
 PLACEHOLDER SYNTAX
   - Prose placeholders use {{double-curly}} form so that
@@ -1444,9 +1450,9 @@ that surface has neither dial.
         executable.
     {{last-2}}. docs/phase{{N}}-qa-
         findings.md exists.
-    {{last-1}}. docs/phase{{N}}-
-        roadmap.md exists (this
-        doc).
+    {{last-1}}. docs/roadmap/
+        phase{{N}}-roadmap.md
+        exists (this doc).
     {{last}}. .github/workflows/
         phase-verify.yml matrix
         includes `{{N}}`.
@@ -1644,9 +1650,9 @@ that surface has neither dial.
     <requirement>
       Mark the phase complete in
       the parent project roadmap
-      (docs/ROADMAP.md, or
-      wherever this project keeps
-      it) in the SAME Stage-3
+      (docs/roadmap/ROADMAP.md,
+      beside this file) in the
+      SAME Stage-3
       commit that marks this step
       (Status rule):
       - `### Phase {{N}}` gets
@@ -2029,7 +2035,7 @@ Each item is one bullet, two sentences max. Lead with the
 deferred thing, follow with where / when it lives instead.
 -->
 
-Per [`docs/ROADMAP.md`](ROADMAP.md) Phase {{N}} "Not in
+Per [`docs/roadmap/ROADMAP.md`](ROADMAP.md) Phase {{N}} "Not in
 scope":
 
 - Item explicitly deferred by the parent roadmap, with a
@@ -2092,9 +2098,9 @@ Example skeleton:
   QA findings rollup, and any tests that need re-running.}}
 
   Audit cross-reference: see
-  [`docs/phase{{N}}-website-audit.md`](phase{{N}}-website-audit.md)
+  [`docs/phase{{N}}-website-audit.md`](../phase{{N}}-website-audit.md)
   finding `PHASE{{N}}-AUDIT-NNN`. QA cross-reference: see
-  [`docs/phase{{N}}-qa-findings.md`](phase{{N}}-qa-findings.md)
+  [`docs/phase{{N}}-qa-findings.md`](../phase{{N}}-qa-findings.md)
   § "{{Back-patch rollup heading}}".
 =============================================================
 -->

{roadmodel-0.2.45/docs/templates → roadmodel-0.2.46/roadmodel/data}/planning-kit-how-to-use.md

@@ -15,8 +15,8 @@ paid API.
 | `model-tier-cost-scale.md` | Per-token **prices** and **subscription tiers** — the funding/cost data the selector's access-selection step consumes. |
 | `settings-display.md` | The **display contract**: how the selector's setting fields map to the real controls each surface exposes (which dials to show, which to omit). Read it before writing any Settings table. |
 | `user-context.md` | The operator's **subscriptions + API keys + platform preference order** — decides *which platform pays* for each pick. |
-| `templates/project-roadmap-template.md` | Skeleton for a whole-project `ROADMAP.md`. |
-| `templates/phase-roadmap-template.md` | Skeleton for one `phaseNN-roadmap.md`. |
+| `templates/project-roadmap-template.md` | Skeleton for a whole-project `docs/roadmap/ROADMAP.md`. |
+| `templates/phase-roadmap-template.md` | Skeleton for one `docs/roadmap/phaseNN-roadmap.md`, beside it. |
 | `prompts/project-roadmap.md` | **Fill-in paste-prompt** that writes `ROADMAP.md` from the project template — refreshes the kit first. |
 | `prompts/phase-roadmap.md` | **Fill-in paste-prompt** that writes one `phaseNN-roadmap.md` — refreshes the kit first. |
 

{roadmodel-0.2.45 → roadmodel-0.2.46}/roadmodel/data/project-roadmap-template.md

@@ -22,6 +22,12 @@ STYLE RULES (the AI MUST follow)
     a per-phase exit gate, never a final-phase afterthought —
     an issue introduced in Phase 2 must be caught in Phase 2,
     before its work is committed, pushed, or merged.
+  - This file lives at `docs/roadmap/ROADMAP.md`, and every
+    phase roadmap (`phaseNN-roadmap.md`) is written beside it:
+    all roadmaps in one folder, none at the repo root. A
+    project that keeps its roadmaps git-excluded (e.g.
+    `private/`) keeps them there. Relative links resolve from
+    `docs/roadmap/` (`../../README.md`, `../ci.md`).
   - Every phase carries a one-line metadata badge:
       **Complexity:** … · **Risk:** … · **Cloud cost:** … ·
       **Handles sensitive data:** <Yes/No — PII, secrets, auth>

{roadmodel-0.2.45/docs/templates → roadmodel-0.2.46/roadmodel/data}/prompt-phase-roadmap.md

@@ -6,12 +6,12 @@ into a **new** chat in the project and submit. Defaults are shown
 for every placeholder; delete a bracketed line if it does not
 apply.
 
-| Placeholder          | Meaning                                   | Default                            |
-| -------------------- | ----------------------------------------- | ---------------------------------- |
-| `{{N}}`              | Phase number (two digits in filenames)    | —                                  |
-| `{{PROJECT_ROADMAP}}` | The parent project roadmap                | `@ROADMAP.md`                      |
-| `{{OUTPUT}}`         | Where the phase roadmap is written        | `docs/phase{{NN}}-roadmap.md`      |
-| `{{PRIOR}}`          | Previous phase roadmap(s), for continuity | `@docs/phase{{NN-1}}-roadmap.md`   |
+| Placeholder          | Meaning                                   | Default                                    |
+| -------------------- | ----------------------------------------- | ------------------------------------------ |
+| `{{N}}`              | Phase number (two digits in filenames)    | —                                          |
+| `{{PROJECT_ROADMAP}}` | The parent project roadmap                | `@docs/roadmap/ROADMAP.md`                 |
+| `{{OUTPUT}}`         | Where the phase roadmap is written        | `docs/roadmap/phase{{NN}}-roadmap.md`      |
+| `{{PRIOR}}`          | Previous phase roadmap(s), for continuity | `@docs/roadmap/phase{{NN-1}}-roadmap.md`   |
 
 ---
 
@@ -31,6 +31,16 @@ line, a step's Status line sits after its `**Deploys:**` line, or its
 Settings tables have no `Backup` row, STOP
 and tell me the kit is stale — do not write the roadmap from it.
 
+Step 0b — roadmaps live in `docs/roadmap/`: `ROADMAP.md` and every
+`phaseNN-roadmap.md`, together. A project that keeps them git-excluded
+(e.g. `private/`) keeps them there, and the rest of this step does not
+apply: a tracked `ROADMAP.md` beside them is a published copy.
+Otherwise, if this project has a `ROADMAP.md` or `phaseNN-roadmap.md`
+anywhere else that git does not ignore (committed, or written and not
+yet committed), STOP and tell me to run `/roadmap-refresh` first: it
+moves them into `docs/roadmap/` and updates every reference to them. Do
+not write a new roadmap beside them.
+
 Step 1 — write `{{OUTPUT}}` from
 `@planning/templates/phase-roadmap-template.md`, expanding the
 Phase {{N}} section of `{{PROJECT_ROADMAP}}` into an executable plan.

{roadmodel-0.2.45/docs/templates → roadmodel-0.2.46/roadmodel/data}/prompt-project-roadmap.md

@@ -9,7 +9,7 @@ apply.
 | Placeholder    | Meaning                                                  | Default                     |
 | -------------- | -------------------------------------------------------- | --------------------------- |
 | `{{BRIEF}}`    | Where the project is described: files, or inline prose   | `@README.md`                |
-| `{{OUTPUT}}`   | Where the roadmap is written                             | `ROADMAP.md`                |
+| `{{OUTPUT}}`   | Where the roadmap is written                             | `docs/roadmap/ROADMAP.md`   |
 | `{{CONSTRAINTS}}` | Hard constraints the roadmap must respect (optional)  | —                           |
 
 ---
@@ -29,6 +29,16 @@ completion line, or a `### Phase` section's `**Status:**` line sits
 after its **Goal:** rather than directly under its heading, STOP and
 tell me the kit is stale — do not write the roadmap from it.
 
+Step 0b — roadmaps live in `docs/roadmap/`: `ROADMAP.md` and every
+`phaseNN-roadmap.md`, together. A project that keeps them git-excluded
+(e.g. `private/`) keeps them there, and the rest of this step does not
+apply: a tracked `ROADMAP.md` beside them is a published copy.
+Otherwise, if this project has a `ROADMAP.md` or `phaseNN-roadmap.md`
+anywhere else that git does not ignore (committed, or written and not
+yet committed), STOP and tell me to run `/roadmap-refresh` first: it
+moves them into `docs/roadmap/` and updates every reference to them. Do
+not write a new roadmap beside them.
+
 Step 1 — write `{{OUTPUT}}` from
 `@planning/templates/project-roadmap-template.md`. The project brief
 is {{BRIEF}}. [Hard constraints: {{CONSTRAINTS}}.] Read the codebase

{roadmodel-0.2.45 → roadmodel-0.2.46}/src/roadmodel/__init__.py

@@ -1,2 +1,2 @@
 # src/roadmodel/__init__.py
-__version__ = "0.2.45"
+__version__ = "0.2.46"