Codex and Claude Code plugin (works in Claude Desktop): choose which past images go to the model with your next message. Unchecked images become placeholders, the conversation goes on, and requests st
Stable. Lore follows semantic versioning: breaking changes to commands, templates, or conventions land only in a major release. Pin to a git tag if you want to control exactly when you take an update (see Versioning).
Lore is a Claude Code plugin that packages a reusable, product-agnostic documentation factory. Install it in any documentation repo to get the same skills, review subagents, and BLOCKING-rule enforcement hooks — maintained once, consumed everywhere.
This single repo is both the plugin (plugins/lore/) and its marketplace (.claude-plugin/marketplace.json).
What is "Lore"?
Lore is the accumulated knowledge of a community — its facts, rules, and stories — kept alive and passed on so nothing has to be relearned from scratch.
That is exactly what product documentation should be. Documentation rots, and every team rebuilds the same writing process from zero. Lore packages that process once: install the plugin and every repo inherits the same skills, the same Definition of Done, and the same guardrails — so a product's knowledge is captured, validated, and kept.
What's inside
Component
Name
Purpose
Command
/lore:init
Scaffold a new docs project (3-question wizard; optional Docusaurus)
Command
/lore:config
Fill in / edit settings anytime (site URL, sources, template, brand, language)
Command
/lore:add-docusaurus
Add the Docusaurus viewer to a docs-only project later
Skill
lore:figma-to-doc
Generate docs from Figma design files
Skill
lore:brief-to-doc
Generate docs from briefs / PRDs / user stories
Skill
lore:site-to-doc
Document live product behavior (scenario runner + screenshots)
Skill
lore:doc-reviewer
Validate docs against the Definition of Done
Subagent
lore:doc-validator
Read-only DoD validator (run by producer skills before delivery)
Subagent
lore:figma-extractor
Heavy Figma extraction worker (keeps main context clean)
Subagent
lore:site-explorer
Heavy live-site exploration worker — drives the browser, captures screenshots (keeps main context clean)
Subagent
lore:doc-reviser
Narrow-contract fixer — applies the validator's findings as one batch, only where they point, and cannot fetch
Hooks
hooks/hooks.json
BLOCKING enforcement of image paths and frontmatter, plus the evidence gates that leave a skipped source visible at delivery
How it works
Three input paths, one consistent pipeline:
Figma design ─┐
Brief / PRD ─┼─▶ Lore skill ─▶ lore:doc-reviewer ─▶ Markdown or static site
Live product ─┘ (generate) (validate vs DoD) (deploy anywhere)
Scaffold — /lore:init lays down the docs layer (and an optional Docusaurus viewer).
Generate — pick the skill that matches your input: figma-to-doc, brief-to-doc, or site-to-doc.
Review — lore:doc-reviewer checks the result against your product's Definition of Done.
Deploy — ship Markdown as-is, or build the static site and host it anywhere.
Install
Installing is two steps, run inside Claude Code (both are idempotent):
/plugin marketplace add hamidpl/lore # 1. add the catalog
/plugin install lore@lore-marketplace # 2. install the plugin
On Claude Code 2.1.275 or later, one command does both:
/plugin install lore --marketplace hamidpl/lore
For a team/CI repo, install at project scope so a clone is self-contained:
Installed ≠ enabled. Installing caches the plugin on your machine; enabling turns it on for a project. If Lore is already installed, don't run install again — just enable it via the /plugin menu (Installed tab → lore → Enable), or add to your project's .claude/settings.json:
/plugin marketplace update lore-marketplace # refresh the catalog
claude plugin update lore@lore-marketplace # update the plugin
Quick start
cd <your-empty-or-existing-project>
/lore:init # answer 3 questions
/lore:init asks 3 essentials — product name, documentation language, install Docusaurus? — then scaffolds the docs layer (docs/ + .claude/) and, if chosen, a Docusaurus viewer.
Docusaurus is optional. Choose No for Markdown-only docs and add a browsable site later with /lore:add-docusaurus.
Language drives styling. An RTL language (Persian, Arabic, …) gets the self-hosted Vazirmatn font + right-to-left layout; LTR languages get stock Docusaurus styling.
Nothing is locked in. Run /lore:config anytime to edit the site URL, product description, trusted sources, doc template, brand color — even the 3 init answers.
Safe in existing repos./lore:init only adds the documentation layer and never overwrites your files.
Then build content with lore:figma-to-doc / lore:brief-to-doc / lore:site-to-doc, validate with lore:doc-reviewer, and deploy the static build/ output to any host.
lore:site-to-doc needs a browser. It drives a real browser to run scenarios and capture screenshots via the Playwright MCP server. Add it once (the skill prompts you if it's missing):
claude mcp add playwright -- npx @playwright/mcp@latest
Division of responsibility (the golden rule)
Lore carries the product-agnostic methodology and the always-on rules. Only product-specific data lives in the consuming repo:
Layer
Where it lives
Skills, subagents, hooks, authoring template + the always-on rules (General Rules + Definition of Done §0/§2/§4–§8)
This plugin — change once, propagate to every repo via /plugin update
Trusted sources, user roles, product overview, structure (DoD §1/§3)
The consuming repo's CLAUDE.md (per-product)
The methodology rules ship as a plugin-owned lore-methodology.md that each repo's thin CLAUDE.md imports; a SessionStart hook keeps it current on /plugin update, so rule improvements reach existing projects automatically (as of v0.6.0). Skills reference rules by section number — they never restate or hard-code a product's sources, roles, or structure. That is what lets one skill serve every product.
Lore uses semantic versioning; the current version lives in plugins/lore/.claude-plugin/plugin.json and changes are recorded in CHANGELOG.md. Since 1.0.0, breaking changes land only in a major release; minor releases add capability and stay backward compatible, and patches fix. To pin a version, add the marketplace at a fixed git tag — e.g. /plugin marketplace add hamidpl/lore#v1.1.0.
Security note: Lore ships hooks that run shell scripts automatically in your repo. Review plugin updates the way you would any dependency bump.
