Skip to content

Retire the top-level plans/ directory and correct the document in it - #834

Merged
Masterplanner25 merged 1 commit into
mainfrom
workflow-framework-plan
Sep 7, 2026
Merged

Masterplanner25 merged 1 commit into
mainfrom
workflow-framework-plan

Conversation

@Masterplanner25

Copy link
Copy Markdown
Owner

plans/ held one file, written 2026-05-30 and never reviewed. It is
docs/design/workflow-framework/00-framework-plan.md now, beside the existing
docs/design/workflow-dsl/ — a subsystem design folder is the shape this repo
already uses, and a top-level directory for a single document is not.

The drift mattered more than the location

Its primary code reference had been wrong for three months. The "Main Code
Areas" section pointed at src/nodus_workflow — a path the NAME-COL-001 rename
removed on 2026-05-31, the day after this plan was written. Anyone following
the plan's own first reference found nothing.

Nine of its links resolved for nobody: machine-local absolute paths of the
form /abs/path/C:/dev/Coding%20Language/src/.... Worth noting that the link
checker added in #833 does not catch these — they are not .md targets — so
this is a second species of broken link, found by reading rather than by the
gate. They are inline code now; a relative link from
docs/design/workflow-framework/ into src/ is four levels of ../ that nobody
will keep correct.

The roadmap is live and was not rewritten

Spot-checked rather than assumed: §1 claims the run inventory uses
offset-derived cursors, and runner.py still has _cursor_offset and
_encode_cursor. The remaining-work items — cursor model, coordination posture,
admin operations, storage scaling, auth hardening — are all still open.

Rewriting a plan is a design session, not a docs sweep.

What it gains

A Last reviewed: header, per the convention #715 established, naming the two
items that moved underneath it:

The header also says plainly that nothing else was re-verified line by line,
so the next reader knows what they are holding.

Checks

  • nodus_gate --all — all ten phases
  • test_doc_links_resolve — clean
  • ruff check . — clean
  • The move is recorded as a rename, so history follows the file

🤖 Generated with Claude Code

https://claude.ai/code/session_01TnzKwmx6XecNEqP2482MuA

plans/ held one file, written 2026-05-30 and never reviewed since. It is
docs/design/workflow-framework/00-framework-plan.md now, beside the existing
docs/design/workflow-dsl/ -- a subsystem design folder is the shape this repo
already uses, and a top-level directory for a single document is not.

The drift mattered more than the location. Its "Main Code Areas" section pointed
at src/nodus_workflow, which the NAME-COL-001 rename removed on 2026-05-31 --
the day after this plan was written. Anyone following the plan's own primary
reference has found nothing for three months. Nine more of its links were
machine-local absolute paths of the form
/abs/path/C:/dev/Coding%20Language/src/... which resolve for nobody, and which
the new link checker does not report because they are not .md targets. Those are
inline code now: a relative link from docs/design/workflow-framework/ into src/
is four levels of ../ that nobody will keep correct.

The roadmap is live and was not rewritten. Spot-checked rather than assumed --
§1 claims the run inventory uses offset-derived cursors, and runner.py still has
_cursor_offset and _encode_cursor. Rewriting a plan is a design session, not a
docs sweep.

What it gains is a `Last reviewed:` header, per the convention #715 established,
naming the two items that moved underneath it: #174 answered part of §2's "is
SQLite the final backend" by making it the 6.0.0 default and shipping
migrate-store, and #380 made §4's inventory scan about 4x cheaper -- the cost was
a mkdir per record and an exists before every open, not parsing -- while leaving
it linear. The header also says plainly that nothing else was re-verified line by
line, so the next reader knows what they are holding.

All ten gate phases green, link checker clean, ruff clean.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01TnzKwmx6XecNEqP2482MuA
@Masterplanner25
Masterplanner25 merged commit 77e7a1d into main Sep 7, 2026
6 checks passed
@Masterplanner25
Masterplanner25 deleted the workflow-framework-plan branch September 7, 2026 21:33
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