docs: fix README headline — spec-driven framing, plain language#112
Open
PatrickSys wants to merge 1 commit into
Open
docs: fix README headline — spec-driven framing, plain language#112PatrickSys wants to merge 1 commit into
PatrickSys wants to merge 1 commit into
Conversation
There was a problem hiding this comment.
Code Review
This pull request updates the README to reframe the project around spec-driven development and persistent markdown files. The feedback identifies an inconsistency in the package.json description that should be addressed to match this new framing and provides a grammatical correction for the updated README text.
| # Workspine | ||
|
|
||
| AI agents forget when the session ends. Workspine writes plans, decisions, and verification to `.planning/` so any agent or runtime can pick up where the last one stopped. | ||
| Spec-driven development for AI-assisted work. The spec, plan, and verification live as markdown files in your repo — so every session starts from the same ground truth instead of a blank chat window. |
There was a problem hiding this comment.
| ## Where it fits | ||
|
|
||
| Use Workspine when a feature takes more than one session, or when you need to switch between Claude, Codex, and Cursor without losing the thread. Skip it for quick, obvious edits — direct prompting is cheaper when the risk is small. | ||
| Use Workspine when a feature takes more than one session, or when you keep switching between Claude, Codex, and Cursor and losing the thread. Skip it for quick obvious edits — just prompting is faster. |
There was a problem hiding this comment.
The phrasing "and Cursor and losing the thread" is slightly clunky due to the repeated conjunction. Additionally, "quick obvious" should be separated by a comma as they are coordinate adjectives modifying "edits".
Suggested change
| Use Workspine when a feature takes more than one session, or when you keep switching between Claude, Codex, and Cursor and losing the thread. Skip it for quick obvious edits — just prompting is faster. | |
| Use Workspine when a feature takes more than one session, or when switching between Claude, Codex, and Cursor causes you to lose the thread. Skip it for quick, obvious edits — just prompting is faster. |
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
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.
Summary
What changed and why
The previous README still led with corporate-sounding language ("delivery spine", "any agent or runtime") that obscured what the tool actually is: markdown files in the repo that give AI agents a consistent spec to follow across sessions. This rewrite leads with that honestly.