Skip to content

Update agent instructions#475

Merged
IEvangelist merged 1 commit intomainfrom
UpdateCopilotInstructions
Feb 25, 2026
Merged

Update agent instructions#475
IEvangelist merged 1 commit intomainfrom
UpdateCopilotInstructions

Conversation

@eerhardt
Copy link
Member

No reason to run pnpm run build after making doc changes as it takes too long.

No reason to run `pnpm run build` after making doc changes as it takes too long.
Copilot AI review requested due to automatic review settings February 25, 2026 19:58
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

Updates contributor/agent guidance to streamline how documentation changes are validated in this repo.

Changes:

  • Adds a new “Verifying documentation changes” section to AGENTS.md.
  • Recommends using pnpm dev instead of a full pnpm run build for doc-only verification.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

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

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.

@IEvangelist IEvangelist merged commit b2113d2 into main Feb 25, 2026
10 checks passed
@IEvangelist IEvangelist deleted the UpdateCopilotInstructions branch February 25, 2026 20:14
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.

3 participants