Skip to content

Update agent instructions #475

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
IEvangelist merged 1 commit into from
Feb 25, 2026
Merged

Update agent instructions #475

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
3 changes: 3 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,9 @@ IMPORTANT! Consider avoiding persistent containers early during development to a
## Aspire workload
IMPORTANT! The aspire workload is obsolete. You should never attempt to install or use the Aspire workload.

## Verifying documentation changes
After making documentation changes, running `pnpm dev` (the dev server) is sufficient to verify that the changes render correctly. A full `pnpm run build` is not required because it takes a long time.
Copy link

Copilot AI Feb 25, 2026

Choose a reason for hiding this comment

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

The guidance here is a bit misleading because pnpm run build (via src/frontend's build script) also runs pnpm linkcheck before astro build. For documentation changes—especially link updates—skipping build means you may miss broken internal links that only get validated during linkcheck/production build. Consider rewording to say pnpm dev is enough to verify rendering, but pnpm linkcheck/pnpm build(:production) should be run when changing links/routing/sidebar content or before merge when feasible (or rely on CI for that).

Suggested change
After making documentation changes, running `pnpm dev` (the dev server) is sufficient to verify that the changes render correctly. A full `pnpm run build` is not required because it takes a long time.
After making documentation changes, running `pnpm dev` (the dev server) is sufficient to verify that the changes render correctly. However, because `pnpm run build` also runs `pnpm linkcheck`, you should run `pnpm linkcheck` or `pnpm run build` when you change links, routing, or sidebar content, or before merging when feasible (or rely on CI to run these checks).

Copilot uses AI. Check for mistakes.
Copy link
Member

@IEvangelist IEvangelist Feb 25, 2026

Choose a reason for hiding this comment

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

No, pnpm linkcheck does a full build.


## Official documentation
IMPORTANT! Always prefer official documentation when available. The following sites contain the official documentation for Aspire and related components

Expand Down
Loading