Update the audit-docs prompt#584
Merged
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 guidance (notably the audit-docs prompt) and applies a broad documentation/comment cleanup across the repo to better align written docs with the current Next.js portfolio implementation.
Changes:
- Expanded and clarified
.github/prompts/audit-docs.prompt.mdwith stricter documentation-only + zero-hallucination guidance (plus language/style constraints). - Refreshed large portions of
docs/(architecture + usage) to match current code structure, routes, and component behaviour. - Reduced/adjusted in-code comments/docstrings and updated supporting contributor/agent guidance files; includes a
package-lock.jsonrefresh.
Reviewed changes
Copilot reviewed 42 out of 43 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| src/constants/index.ts | Clarified NETWORK constant comments. |
| src/components/Stars/StarsBackground.tsx | Removed a redundant inline comment. |
| src/components/projects/ProjectsGrid.tsx | Removed redundant inline comments in scroll helper. |
| src/components/navbar/Navbar.tsx | Removed an ESLint disable and a redundant comment. |
| src/components/banner/Avatar.tsx | Added a module-level docstring describing behaviour. |
| src/app/robots.ts | Added a brief route docstring. |
| src/app/not-found.tsx | Clarified component docstring; removed redundant comment. |
| src/app/manifest.ts | Added a brief route docstring. |
| README.md | Removed sponsorship section. |
| public/sw.js | Updated fetch-skip comments to match behaviour. |
| package-lock.json | Dependency lockfile refresh (Rollup/js-yaml and related entries). |
| docs/usage/testing.md | Updated Cypress example and CI workflow references. |
| docs/usage/setup.md | Documented NEXT_PUBLIC_SENTRY_ORG and tightened env-var formatting. |
| docs/index.md | Updated high-level rendering description and replaced em-dash separators. |
| docs/architecture/utils.md | Updated utility descriptions/links and added cookie-consent utility coverage. |
| docs/architecture/service-worker.md | Updated service worker skip rules description. |
| docs/architecture/pwa.md | Refined manifest/service worker explanations and wording. |
| docs/architecture/layouts.md | Updated layout structure description and diagram details. |
| docs/architecture/index.md | Updated architectural flow description and links to specific source files. |
| docs/architecture/images.md | Updated asset links and icon wrapper example. |
| docs/architecture/helpers.md | Updated AAAAHHHH transformation description and wording. |
| docs/architecture/data.md | Updated data-flow diagram and “data-as-code” explanations/links. |
| docs/architecture/constants.md | Documented MAX_STARS and updated constants descriptions. |
| docs/architecture/configs.md | Wording/link formatting updates for configs and Sentry section. |
| docs/architecture/components/stars.md | Updated links and StarsBackground behaviour description. |
| docs/architecture/components/socials.md | Updated Footer/socials flow description and links. |
| docs/architecture/components/publications.md | Updated publications behaviour description and links. |
| docs/architecture/components/projects.md | Updated ProjectsGrid flow and example schema notes. |
| docs/architecture/components/navbar.md | Updated navbar behaviour (no resume link) and links. |
| docs/architecture/components/index.md | Updated component hierarchy diagrams and cookie persistence note. |
| docs/architecture/components/cookie-snackbar.md | Updated cookie consent logic description and links. |
| docs/architecture/components/avatar.md | Updated banner/avatar docs and corrected links/wording. |
| docs/architecture/app-directory.md | Updated App Router conventions section and links. |
| CONTRIBUTING.md | Fixed README links to be relative and consistent. |
| CLAUDE.md | Updated .claude/rules/ link target. |
| .github/prompts/readme.md | Updated prompt configuration guidance (targets/context). |
| .github/prompts/audit-quality.prompt.md | Removed targets frontmatter block. |
| .github/prompts/audit-pr.prompt.md | Removed targets and adjusted fenced-block language tag. |
| .github/prompts/audit-docs.prompt.md | Major rewrite/clarification of audit-docs rules and workflow. |
| .github/copilot-instructions.md | Updated formatting/security header/service worker notes. |
| .claude/skills/audit-docs/SKILL.md | Synced skill guidance with updated audit-docs prompt rules. |
| .claude/rules/docs-authoring.md | Added/expanded style rules (no em-dashes, Canadian English, acronyms). |
| .claude/rules/code-style.md | Replaced em-dashes with hyphens and tightened wording. |
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.
Update the
audit-docsprompt with the intent of reducing hallucination rates as well as added instructions about em-dashes, Canadian English and acronyms.