Update doc prompts to not duplicate implementation note#576
Merged
AlexJSully merged 5 commits intomainfrom Feb 19, 2026
Merged
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the repository’s documentation-auditing prompts to discourage redundant “Implementation:” citations and to enforce consistent file-linking in docs, with a few accompanying doc tweaks and some unrelated maintenance changes.
Changes:
- Refines
.github/promptsguidance (inline linking preference, avoid duplicate citations, stricter file reference linking). - Updates a couple of docs to use more explicit links and removes an outdated troubleshooting placeholder.
- Includes unrelated maintenance changes (dependency bumps and small helper refactors/types).
Reviewed changes
Copilot reviewed 6 out of 7 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
src/helpers/aaaahhhh.ts |
Minor refactor: removes inline comments and adds explicit return types. |
package.json |
Updates dependency versions (Sentry, eslint-plugin-cypress, @types/node, caniuse-lite). |
package-lock.json |
Lockfile update reflecting the dependency bumps. |
docs/usage/setup.md |
Tweaks env var guidance, adds links (but currently introduces a broken .env.example link). |
docs/architecture/configs.md |
Removes a top “Implementation:” line and adds links for Sentry config files. |
.github/prompts/audit-pr.prompt.md |
Formatting/structure tweaks for the PR audit prompt output template. |
.github/prompts/audit-docs.prompt.md |
Adds/clarifies citation/linking rules (but current examples have Markdown rendering issues). |
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.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.
No description provided.