docs: fix 15 documentation-code discrepancies from code review#149
Merged
docs: fix 15 documentation-code discrepancies from code review#149
Conversation
Fixes found during code review of changes since v1.4.7: CLI README (packages/cli/README.md): - Add missing `prs migrate` command documentation - Replace deprecated `prs init --migrate` in Quick Start with `prs init`/`prs migrate` - Add `--auto-import` and `--backup` flags to init options table - Update "AI-assisted migration" feature bullet to mention static migration Language reference (docs/reference/language.md): - Fix `@agents` example using `syntax: "1.0.0"` (requires "1.1.0" per PS018) - Clarify `@workflows`/`@prompts` are internal, not user-facing blocks - Add `@commands` to Reserved Words block names list - Add `### @commands` section documenting it as alias for `@shortcuts` Package READMEs: - Fix phantom `version` field in `SyntaxVersionDef` (core/README.md) - Fix PS018 description to reflect early-return on unknown version (validator/README.md) Design docs: - Update status from "Approved" to "Implemented" (both design docs) - Fix `--import` → `--auto-import` in non-interactive behavior matrix - Fix tool-specific hints to match implementation (skill invocation, not paste) - Remove unimplemented "Review needed: N sections" from confidence report - Fix `--llm` description (clipboard-first, not stdout-first) - Remove "configurable via promptscript.yaml" claim (not implemented) SKILL.md (all 4 copies): - Clarify `@workflows`/`@prompts` are internal in version table - Add `prs upgrade` behavior description (latest version vs minimum)
Bundle ReportChanges will increase total bundle size by 1.32kB (0.11%) ⬆️. This is within the configured threshold ✅ Detailed changes
Affected Assets, Files, and Routes:view changes for bundle: promptscript-cliAssets Changed:
|
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
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.
Summary
Fixes 15 documentation-code discrepancies found during code review of changes since v1.4.7 (PRs #146 and #147).
Critical fixes
prs migratecommand documentation to CLI READMEprs init --migratein Quick Start withprs init/prs migrate--auto-importand--backupflags to init options table### @commandssection to language reference (block exists in code but was undocumented)versionfield inSyntaxVersionDefinterface docs (core README)Warning fixes
@agentsexample usingsyntax: "1.0.0"→"1.1.0"(would trigger PS018)@workflows/@promptsas internal blocks in version tables and SKILL.md--import→--auto-importin design doc non-interactive behavior matrix--llmbehavior description (clipboard-first, not stdout-first)Suggestion fixes
prs upgradebehavior distinction in all SKILL.md copiesTest plan
pnpm run format— passpnpm run lint— passpnpm run typecheck— passpnpm run test— 660 tests passpnpm prs validate --strict— passpnpm schema:check— passpnpm skill:check— all copies in syncpnpm docs:validate— all 135 snapshots valid