Skip to content

Improve all prompt docs#578

Merged
AlexJSully merged 6 commits intomainfrom
alexjsully-260311-update-audit-doc
Mar 12, 2026
Merged

Improve all prompt docs#578
AlexJSully merged 6 commits intomainfrom
alexjsully-260311-update-audit-doc

Conversation

@AlexJSully
Copy link
Owner

Improve all agentic prompt docs to work better with VSCode's GitHub Copilot by making them shorter and more focused.

In addition, ran those prompts and their code changes are included in this PR.

@AlexJSully AlexJSully requested a review from Copilot March 12, 2026 01:23
@AlexJSully AlexJSully self-assigned this Mar 12, 2026
@vercel
Copy link

vercel bot commented Mar 12, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
portfolio Ready Ready Preview, Comment Mar 12, 2026 1:37am

Copy link
Contributor

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 updates the repository’s “agentic prompt” documentation to be shorter/more focused for GitHub Copilot usage, and includes several prompt-driven code/documentation changes across utilities, UI components, test tooling, and architecture docs.

Changes:

  • Refines/shortens .github/prompts/* prompt docs and updates the prompts README.
  • Improves/clarifies a handful of app utilities/components (network speed detection docs, service worker registration retry logic, stars background limits, cookie consent helpers).
  • Adds Mermaid diagram accessibility metadata (accTitle, accDescr) across many architecture docs.

Reviewed changes

Copilot reviewed 32 out of 35 changed files in this pull request and generated 11 comments.

Show a summary per file
File Description
src/util/isNetworkFast.ts Expands JSDoc explaining Network Information API heuristics and thresholds.
src/util/cookieConsent.ts Adds cookie-consent helper utilities and cookie option constants.
src/images/icons.tsx Tightens typings around SVG icon wrapper helper.
src/helpers/aaaahhhh.ts Cleans up helper docs and replaces for...in loops with index loops for DOM collections.
src/helpers/aaaahhhh.test.ts Minor iteration style tweak (const in loop).
src/constants/index.ts Adds MAX_STARS constant for capping star rendering.
src/configs/firebase.ts Improves docstrings and refactors perf init to avoid unused variable.
src/components/cookie-snackbar/CookieSnackbar.tsx Updates cookie attributes (adds SameSite=Strict).
src/components/Stars/StarsBackground.tsx Caps number of stars via MAX_STARS and stabilizes React keys.
src/components/ServiceWorkerRegister.tsx Adds retry logic/backoff for service worker registration.
package.json Bumps dependency/devDependency versions and removes Prettier ESLint integration packages.
next-env.d.ts Updates generated route-types import path.
jest.config.js Adds additional module alias mappings for Jest.
eslint.config.js Removes eslint-plugin-prettier integration/rule from ESLint flat config.
docs/usage/testing.md Adds Mermaid accessibility fields to validation pipeline diagram.
docs/architecture/utils.md Adds Mermaid accessibility fields to network-speed decision diagram.
docs/architecture/pwa.md Adds Mermaid accessibility fields to PWA flow diagram.
docs/architecture/layouts.md Adds Mermaid accessibility fields to layout composition diagram.
docs/architecture/index.md Adds Mermaid accessibility fields to request lifecycle diagram.
docs/architecture/helpers.md Adds Mermaid accessibility fields to AAAAHHHH flow diagram.
docs/architecture/data.md Adds Mermaid accessibility fields to data build-time sequence diagram.
docs/architecture/components/stars.md Adds Mermaid accessibility fields to multiple Stars diagrams and removes a stray import snippet.
docs/architecture/components/socials.md Adds Mermaid accessibility fields to socials flow diagram.
docs/architecture/components/publications.md Adds Mermaid accessibility fields to publications flow diagram.
docs/architecture/components/projects.md Adds Mermaid accessibility fields to projects flow diagram.
docs/architecture/components/navbar.md Adds Mermaid accessibility fields and updates docs for Socials link behavior/analytics.
docs/architecture/components/index.md Adds Mermaid accessibility fields to component composition/data-flow diagrams.
docs/architecture/components/cookie-snackbar.md Adds Mermaid accessibility fields to cookie snackbar diagrams.
docs/architecture/components/avatar.md Adds Mermaid accessibility fields to avatar interaction sequence diagram.
docs/architecture/app-directory.md Adds Mermaid accessibility fields to app router hierarchy diagram.
.github/prompts/readme.md Shortens and refocuses prompt documentation descriptions.
.github/prompts/audit-quality.prompt.md Substantially condenses prompt while retaining required structure/rules.
.github/prompts/audit-pr.prompt.md Condenses prompt and streamlines review categories/format guidance.
.github/prompts/audit-docs.prompt.md Condenses prompt and reinforces Mermaid accessibility requirements and citation rules.

You can also share your feedback on Copilot code review. Take the survey.

@AlexJSully AlexJSully merged commit 4ea1cc3 into main Mar 12, 2026
8 checks passed
@AlexJSully AlexJSully deleted the alexjsully-260311-update-audit-doc branch March 12, 2026 01:41
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.

2 participants