docs: add detailed agent instructions for testing and spellchecking#1048
Open
jkowall wants to merge 1 commit intojaegertracing:mainfrom
Open
docs: add detailed agent instructions for testing and spellchecking#1048jkowall wants to merge 1 commit intojaegertracing:mainfrom
jkowall wants to merge 1 commit intojaegertracing:mainfrom
Conversation
There was a problem hiding this comment.
Pull request overview
This PR enhances documentation for AI agents and expands the frontend UI configuration reference. It adds comprehensive testing and spellchecking instructions to AGENTS.md while documenting several previously undocumented UI configuration options.
Key changes:
- Added step-by-step testing and verification workflow to AGENTS.md
- Documented spellcheck configuration and dictionary management for AI agents
- Expanded frontend-ui.md with detailed configuration options for themes, critical path, tag prefixes, trace graphs, and UI controls
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| AGENTS.md | Adds comprehensive testing/verification steps, spellchecking guidance, and documentation versioning instructions for AI agents |
| content/docs/v2/_dev/deployment/frontend-ui.md | Documents new UI configuration options including themes, critical path visualization, top tag prefixes, trace graph settings, and UI control toggles |
| .cspell/project-words.txt | Adds "Emscripten" (GraphViz module technology) to the custom dictionary in correct alphabetical order |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
yurishkuro
reviewed
Dec 26, 2025
yurishkuro
reviewed
Dec 26, 2025
jkowall
force-pushed
the
add-agent-instructions
branch
2 times, most recently
from
0ce1ee4 to
99d9638
Compare
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 1 out of 1 changed files in this pull request and generated 1 comment.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Add concise verification checklist and spellcheck dictionary guidance for AI agents, referencing CONTRIBUTING.md for full procedures instead of duplicating them. Signed-off-by: Jonah Kowall <jkowall@kowall.net>
jkowall
force-pushed
the
add-agent-instructions
branch
from
99d9638 to
7dd5767
Compare
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.
Summary
This PR enhances the AGENTS.md file with more comprehensive guidance for AI agents working on the documentation.
Changes
Testing and Verification: Added step-by-step instructions for verifying changes locally:
npm installmake developnpm run buildSpellchecking Guidance: Added detailed information about:
.cspell.yml.cspell/directoryproject-words.txt(sorted alphabetically)project-names-src.txtDocumentation Versioning: Added guidance on:
_dev/vs versioned directories)Human-Centric Guidelines Reference: Added note pointing to CONTRIBUTING.md for DCO signing, PR etiquette, and community interaction guidelines.
Troubleshooting: Added section for spellcheck failures.
Testing