Skip to content

Harden prompt-doc example link hygiene and codify placeholder-path policy#14

Merged
Rtur2003 merged 13 commits intomainfrom
copilot/analyze-codebase-another-one
Apr 19, 2026
Merged

Harden prompt-doc example link hygiene and codify placeholder-path policy#14
Rtur2003 merged 13 commits intomainfrom
copilot/analyze-codebase-another-one

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Apr 19, 2026

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

    • Replaced non-resolving internal Markdown links in prompt examples with inline code literals.
    • Updated:
      • prompts/english/agents/documentation-prompt.md
      • prompts/english/agents/developer-experience-tooling-prompt.md
      • prompts/english/project-types/general-software-development-prompt.md
  • Contributor policy update

    • Added a validation checklist rule in CONTRIBUTING.md:
      • hypothetical example paths must be written as plain code literals, not Markdown links.
  • Changelog alignment

    • Added an Unreleased note in CHANGELOG.md documenting the new example-path guidance.

Example

# Before
See [API Documentation](docs/API.md)

# After
See `docs/API.md` (example path).

Validation

  • npx markdownlint-cli2 '**/*.md'
  • Automated Code Review ✅
  • CodeQL Security Scan ✅

Copilot AI and others added 13 commits April 19, 2026 07:33
@Rtur2003 Rtur2003 marked this pull request as ready for review April 19, 2026 08:31
Copilot AI review requested due to automatic review settings April 19, 2026 08:31
@Rtur2003 Rtur2003 merged commit e3d39fb into main Apr 19, 2026
2 checks passed
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread CHANGELOG.md
Comment on lines +9 to 33
### 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
Copy link

Copilot AI Apr 19, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

## [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).

Copilot uses AI. Check for mistakes.
Comment thread README.md
Comment on lines +77 to +87
## 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).
Copy link

Copilot AI Apr 19, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copilot uses AI. Check for mistakes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants