Harden prompt-doc example link hygiene and codify placeholder-path policy#14
Harden prompt-doc example link hygiene and codify placeholder-path policy#14
Conversation
Agent-Logs-Url: https://github.com/Rtur2003/Claude-Code-Promts/sessions/c3251d0a-34cf-45ef-9565-88d703e3964c Co-authored-by: Rtur2003 <111705644+Rtur2003@users.noreply.github.com>
Agent-Logs-Url: https://github.com/Rtur2003/Claude-Code-Promts/sessions/c3251d0a-34cf-45ef-9565-88d703e3964c Co-authored-by: Rtur2003 <111705644+Rtur2003@users.noreply.github.com>
Agent-Logs-Url: https://github.com/Rtur2003/Claude-Code-Promts/sessions/c3251d0a-34cf-45ef-9565-88d703e3964c Co-authored-by: Rtur2003 <111705644+Rtur2003@users.noreply.github.com>
Agent-Logs-Url: https://github.com/Rtur2003/Claude-Code-Promts/sessions/c3251d0a-34cf-45ef-9565-88d703e3964c Co-authored-by: Rtur2003 <111705644+Rtur2003@users.noreply.github.com>
Agent-Logs-Url: https://github.com/Rtur2003/Claude-Code-Promts/sessions/c3251d0a-34cf-45ef-9565-88d703e3964c Co-authored-by: Rtur2003 <111705644+Rtur2003@users.noreply.github.com>
Agent-Logs-Url: https://github.com/Rtur2003/Claude-Code-Promts/sessions/c3251d0a-34cf-45ef-9565-88d703e3964c Co-authored-by: Rtur2003 <111705644+Rtur2003@users.noreply.github.com>
Agent-Logs-Url: https://github.com/Rtur2003/Claude-Code-Promts/sessions/c3251d0a-34cf-45ef-9565-88d703e3964c Co-authored-by: Rtur2003 <111705644+Rtur2003@users.noreply.github.com>
Agent-Logs-Url: https://github.com/Rtur2003/Claude-Code-Promts/sessions/117b314f-1e1a-4d0b-af99-1e142508560e Co-authored-by: Rtur2003 <111705644+Rtur2003@users.noreply.github.com>
Agent-Logs-Url: https://github.com/Rtur2003/Claude-Code-Promts/sessions/117b314f-1e1a-4d0b-af99-1e142508560e Co-authored-by: Rtur2003 <111705644+Rtur2003@users.noreply.github.com>
Agent-Logs-Url: https://github.com/Rtur2003/Claude-Code-Promts/sessions/2e4c8bf3-860e-4d2d-9bbe-5fc47c5fea05 Co-authored-by: Rtur2003 <111705644+Rtur2003@users.noreply.github.com>
Agent-Logs-Url: https://github.com/Rtur2003/Claude-Code-Promts/sessions/3bd721b1-25f8-40e0-b95b-ae81e483d1bf Co-authored-by: Rtur2003 <111705644+Rtur2003@users.noreply.github.com>
Agent-Logs-Url: https://github.com/Rtur2003/Claude-Code-Promts/sessions/c6daba6c-ac4e-4e6c-aebb-57ec59e69d42 Co-authored-by: Rtur2003 <111705644+Rtur2003@users.noreply.github.com>
Agent-Logs-Url: https://github.com/Rtur2003/Claude-Code-Promts/sessions/c8c4d720-2964-4e95-8beb-f2585c38f083 Co-authored-by: Rtur2003 <111705644+Rtur2003@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
This PR reduces broken-link noise in prompt documentation by replacing hypothetical internal Markdown links with non-link code literals, and formalizes prompt-portfolio governance (including archiving overlapping prompts) across contributor guidance and primary indexes.
Changes:
- Replaced hypothetical example-path Markdown links with inline code literals in prompt examples and guidance.
- Archived several overlapping agent prompts and added compatibility “deprecated” stubs plus an archive index.
- Reworked repository navigation/docs (README, indexes, QUICK-START/USAGE), and added
llms.txt, a portfolio maintenance guide, and a markdownlint baseline config.
Reviewed changes
Copilot reviewed 28 out of 28 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| prompts/english/workflows/portfolio-maintenance-guide.md | Adds monthly/quarterly governance guidance for prompt portfolio maintenance. |
| prompts/english/project-types/general-software-development-prompt.md | Fixes heading formatting and replaces a hypothetical API doc link with a non-link example path. |
| prompts/english/examples/debugging-example.md | Updates related prompt link to the active debugging prompt. |
| prompts/english/examples/README.md | Aligns example metadata to the renamed/active debugging prompt. |
| prompts/english/agents/prompt-chaining-prompt.md | Replaces active prompt content with a deprecation stub pointing to archive and active alternatives. |
| prompts/english/agents/project-workflow-prompt.md | Replaces active prompt content with a deprecation stub pointing to archive and active alternatives. |
| prompts/english/agents/integration-guardian-prompt.md | Replaces active prompt content with a deprecation stub pointing to archive and active alternatives. |
| prompts/english/agents/error-analysis-prompt.md | Replaces active prompt content with a deprecation stub pointing to archive and active alternatives. |
| prompts/english/agents/documentation-prompt.md | Converts hypothetical example paths from links to code literals in a documentation template snippet. |
| prompts/english/agents/developer-experience-tooling-prompt.md | Converts a hypothetical doc link to a code literal example path. |
| prompts/english/agents/claude-code-token-optimization-prompt.md | Replaces active prompt content with a deprecation stub pointing to archive and active alternatives. |
| prompts/english/agents/claude-agent-system-prompt.md | Refactors core agent system prompt structure and templates toward outcome-first guidance. |
| prompts/english/agents/archive/prompt-chaining-prompt.md | Adds archived copy of the prompt chaining content. |
| prompts/english/agents/archive/project-workflow-prompt.md | Adds archived copy of the project workflow content. |
| prompts/english/agents/archive/integration-guardian-prompt.md | Adds archived copy of the integration guardian content. |
| prompts/english/agents/archive/error-analysis-prompt.md | Adds archived copy of the error analysis content. |
| prompts/english/agents/archive/claude-code-token-optimization-prompt.md | Adds archived copy of the token optimization content. |
| prompts/english/agents/archive/INDEX.md | Introduces archive index and rationale table for archived prompts. |
| prompts/english/agents/INDEX.md | Reworks agent index into an outcome-first active catalog plus archived section. |
| prompts/english/INDEX.md | Simplifies global prompt index to point to active/archived catalogs and key resources. |
| llms.txt | Adds a concise LLM-oriented repository entrypoint and navigation map. |
| USAGE.md | Rewrites usage guidance around “Agent System first + one specialist” selection rules. |
| README.md | Reworks primary docs into outcome-first navigation; documents archived prompts and quality gates. |
| QUICK-START.md | Rewrites quick-start selector around minimal prompt composition and catalogs. |
| CONTRIBUTING.md | Updates contributor rules, adds placeholder-path policy, and updates validation checklist. |
| CLAUDE.md | Updates repo structure documentation and adds archive workflow guidance. |
| CHANGELOG.md | Adds Unreleased notes documenting the navigation, governance, and link hygiene changes. |
| .markdownlint-cli2.jsonc | Adds markdownlint-cli2 baseline configuration aligned to repo conventions. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ### Added | ||
| - **LLM-friendly repository index** — Added root `llms.txt` with concise start points, core prompt, governance files, key specialist prompts, and archive index | ||
| - **Prompt archive index** — Added `prompts/english/agents/archive/INDEX.md` with keep/merge/archive classification and rationale | ||
| - **Portfolio Maintenance Guide** — Added `prompts/english/workflows/portfolio-maintenance-guide.md` with monthly + quarterly governance cadence | ||
| - **Compatibility stubs for archived prompts** — Added deprecation redirect files for archived prompt paths | ||
| - **Repository markdownlint baseline config** — Added `.markdownlint-cli2.jsonc` aligned with current repository Markdown conventions to reduce noisy lint failures on dense prompt docs | ||
|
|
||
| ### Changed | ||
| - **Primary documentation navigation** — Added `llms.txt` links in README and QUICK-START for faster agent/document discovery | ||
| - **Internal example link hygiene** — Replaced non-existent markdown links in prompt examples with explicit example-path code literals to avoid broken internal references | ||
| - **Contribution guidance for example paths** — Added a checklist rule in `CONTRIBUTING.md` to keep hypothetical paths as code literals instead of Markdown links | ||
| - **Contribution checklist** — Added `llms.txt` maintenance check when core navigation or prompt structure changes | ||
| - **Outcome-first repository structure** — Reworked README, QUICK-START, USAGE, and prompt indexes around “Agent System first + one specialist” selection | ||
| - **Agent catalog model** — Split active catalog from archived prompts and removed archived prompts from active listings | ||
| - **Contribution quality gates** — Added no-vague-advice rule and archive workflow to CONTRIBUTING and CLAUDE guidance | ||
| - **Core docs code fences** — Added explicit `text` language tags to unlabeled fenced blocks in README and QUICK-START | ||
| - **Lint compatibility tuning** — Adjusted markdownlint baseline for intentional prompt-document patterns (collapsible HTML sections and Makefile tabs in code blocks) | ||
| - **Prompt formatting cleanup** — Fixed heading style issues in `general-software-development-prompt.md` (`Arrange-Act-Assert` heading and `C#` heading rendering) | ||
|
|
||
| ### Removed | ||
| - **Five prompts from active catalog** — Error Analysis, Project Workflow, Integration Guardian, Claude Code Token Optimization, and Prompt Chaining moved to archive | ||
|
|
||
| ### Added | ||
| - **Database Design & Optimization prompt** — QUERY protocol for schema design, normalization decisions, composite indexing strategy, EXPLAIN ANALYZE workflow, N+1 detection, connection pooling, zero-downtime migration patterns, and performance monitoring queries | ||
| - **UI/UX & Design Systems prompt** — DESIGN protocol for design token hierarchy (global → alias → component), variant-driven components (CVA), compound component pattern, accessibility by default (WCAG 2.2), responsive patterns, Storybook documentation, theme system with dark mode, and visual regression testing |
There was a problem hiding this comment.
## [Unreleased] now contains two separate ### Added sections (lines 9 and 31). This breaks the usual Keep a Changelog structure and makes it unclear which items belong together; consider merging the later ### Added entries into the first ### Added block (and likewise ensure each subsection appears only once per release).
| ## Archived (Merged) Prompts | ||
|
|
||
| These were removed from the active catalog to reduce overlap: | ||
|
|
||
| - Error Analysis | ||
| - Project Workflow | ||
| - Integration Guardian | ||
| - Claude Code Token Optimization | ||
| - Prompt Chaining | ||
|
|
||
| See [Archive Index](prompts/english/agents/archive/INDEX.md). |
There was a problem hiding this comment.
The PR description/title focuses on link-hygiene + placeholder-path policy, but this README change also documents a broader scope (archiving multiple prompts and a substantial navigation/selection-model rewrite). Please update the PR description/title to reflect these additional changes, or split the archive/restructure work into a separate PR to keep review scope clear.
Prompt docs used Markdown links for hypothetical paths (e.g.,
docs/API.md) that do not exist in-repo, creating avoidable broken-link noise and review churn. This change converts those examples to non-link literals and formalizes the rule in contributor guidance.Changes
Prompt example link cleanup
prompts/english/agents/documentation-prompt.mdprompts/english/agents/developer-experience-tooling-prompt.mdprompts/english/project-types/general-software-development-prompt.mdContributor policy update
CONTRIBUTING.md:Changelog alignment
Unreleasednote inCHANGELOG.mddocumenting the new example-path guidance.Example
Validation
npx markdownlint-cli2 '**/*.md'✅