Repository navigation
docs: add quick start and prompting guide, move style guide into authoring - #7
Merged
Merged
Conversation
…oring Add docs/quick-start.md (tutorial: install, review, fact-check, amendment entry, HTML preview, on a throwaway branch) and docs/prompting-guide.md (how-to: prompts by authoring situation). Remove docs/spec-style-guide.md. Its register, structure, cross-reference and figure conventions already live in content-patterns, authoring and review. Its admonition, code-block and table conventions move to authoring/references/asciidoc-syntax.md, which authoring and content-patterns now point to. Drop the four links to the old file and add the prompting guide to the inventory-sync rule. Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
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
Adds two human-readable docs for people who use the
openehr-specsplugin, and removesdocs/spec-style-guide.md.docs/quick-start.mdis a tutorial. It clones BASE and AA_GLOBAL, installs the plugin, reviews a chapter, fact-checks class names, adds an amendment record entry and builds the HTML preview, all on a throwaway branch that the last step discards.docs/prompting-guide.mdis a how-to organised by situation: new spec, chapters, prose, amendment record, class changes, review, preview, releases, ITS-REST, scaffold and commit messages. Each has a copyable prompt and notes on what to check.docs/install.mdand the plugin README.Style guide. It restated conventions that already live in
content-patterns,authoringandreview, and it was a second copy to keep in step. The three conventions no skill carried (admonitions, code blocks, tables) move toskills/authoring/references/asciidoc-syntax.md, whichauthoringandcontent-patternspoint to. The four links to the old file are removed, and the prompting guide is added to the inventory-sync rule inAGENTS.mdandCONTRIBUTING.md.Reviewer notes
AGENTS.md: the style-guide bullet is removed, anddocs/prompting-guide.mdis added to the list of docs that move with the skill inventory.scripts/validate.pydoes not check these docs. The skill and subagent names in the prompting guide are an inventory kept by hand.Checklist
python3 scripts/validate.pyandpython3 -m unittest discover -s scripts -p 'test_*.py'passidentifier-groundingstep, marketplace install and a full run from a clean machine were not.Unreleased; no version bumpprose-revieweragent, and its seven major findings are fixed.🤖 Generated with Claude Code