Skip to content

Update audit-docs prompt with how to write directory links #579

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
AlexJSully merged 1 commit into from
Mar 21, 2026
Merged

Update audit-docs prompt with how to write directory links #579

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion .github/prompts/audit-docs.prompt.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -157,6 +157,9 @@ No exceptions. Do not output any diagram missing either field.
- **Every file reference must be a clickable markdown link.** `[filename](relative/path)` — no bare filenames, no exceptions.
- ❌ "See server.ts for the implementation"
- ✅ "See [`server.ts`](../src/server.ts) for the implementation"
- **Markdown links must target files, not directories.** If the visible text refers to a directory, link to a file inside that directory such as `index.md`, `README.md`, or the most relevant existing file.
- ❌ "[`/design`](../design)"
- ✅ "[`/design`](../design/index.md)"
- **Inline preferred:** Weave links into prose. Use footer `Implementation:` only when inline is unnatural.
- **No redundant citations:** Don't link the same file twice in adjacent sentences.
- **Non-existent files:** If the file doesn't exist, re-evaluate and remove or correct the statement.
Expand Down Expand Up @@ -227,7 +230,7 @@ For **every statement** you wrote:
### Content & Style Checks

- Pre-existing content modified only for factual errors? Accurate content preserved?
- All file references are clickable links? (fix or delete — ZERO TOLERANCE)
- All file references are clickable links that resolve to files, not directories? (fix or delete — ZERO TOLERANCE)
- Config docs use external-facing names only? (trace to source or delete)
- No new subjective adjectives? (preserve existing ones)
- No code dumps? (replace with links)
Expand Down
8 changes: 4 additions & 4 deletions docs/architecture/app-directory.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,8 @@ The root layout renders GeneralLayout which provides navigation, footer, backgro

**Global Styles:** Imports [globals.scss](../../src/styles/globals.scss) for application-wide CSS.

**Service Worker:** Registers the service worker for PWA functionality.

**Analytics:** Includes Vercel SpeedInsights for performance tracking.

Implementation: [src/app/layout.tsx](../../src/app/layout.tsx)
Expand All @@ -59,8 +61,6 @@ The home page ([src/app/page.tsx](../../src/app/page.tsx)) is a client component

**Console Logo:** Debounced ASCII art logged to browser console via [ascii helper](../../src/helpers/ascii.ts).

**Service Worker Registration:** Registers `/sw.js` for PWA offline support. Registration runs once on page load.

**Content Rendering:** Displays Banner, ProjectsGrid, and Publications components in vertical stack.

Implementation: [src/app/page.tsx](../../src/app/page.tsx)
Expand All @@ -73,11 +73,11 @@ Implementation: [src/app/page.tsx](../../src/app/page.tsx)

## Error Handling

**Error Boundary** ([src/app/error.tsx](../../src/app/error.tsx)) — Catches errors in route segments and displays fallback UI with reset button.
**Error Boundary** ([src/app/error.tsx](../../src/app/error.tsx)) — Catches errors in route segments and displays fallback UI with a "Go Home" button.

**Global Error** ([src/app/global-error.tsx](../../src/app/global-error.tsx)) — Catches errors in root layout, including its own `<html>` and `<body>` tags since layout errors prevent normal rendering.

Both error boundaries are client components that accept `error` and `reset` props.
Both error boundaries are client components that accept an `error` prop.

## Loading & 404

Expand Down
12 changes: 0 additions & 12 deletions docs/architecture/configs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,18 +51,6 @@ import * as Sentry from '@sentry/nextjs';
Sentry.init({ dsn: process.env.NEXT_PUBLIC_SENTRY_DSN });
```

### Next.js Config Example

```js
// next.config.js
module.exports = {
reactStrictMode: true,
env: {
NEXT_PUBLIC_API_KEY: process.env.NEXT_PUBLIC_API_KEY,
},
};
```

## Integration & Relationships

- Configs are imported by components, helpers, and backend logic for environment-specific behavior.
Expand Down
Loading
Loading