Add AGENTS.md/CLAUDE.md guidance for AI agents writing docs - #28
Open
sensei-hacker wants to merge 2 commits into
Open
sensei-hacker wants to merge 2 commits into
sensei-hacker wants to merge 2 commits into
Conversation
Grounds evidence-based writing requirements, a source reliability ranking, and a mandatory sub-agent critical-review step in concrete precedent from this repo's own PR history, so agents have a checkable bar rather than generic advice. Claude-Session: https://claude.ai/code/session_01YbtjVLXNSuAxcW81c1SuiY
Code Review by Qodo🐞 Bugs (0) 📘 Rule violations (0) 📎 Requirement gaps (0)
Great, no issues found!Qodo reviewed your code and found no material issues that require reviewTip of the day💡 Did you know, you can ask Qodo to dismiss a finding you disagree with, with your reason on record |
PR Summary by QodoAdd evidence-based AI documentation guidelines
AI Description
Diagram
High-Level Assessment
Files changed (2)
|
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
Adds
AGENTS.md(canonical guidance) and a shortCLAUDE.mdthat@-includes it, giving AI coding agents concrete, checkable standards for writing this site's pilot-facing documentation:settings.yaml/.csource/Configurator source rank highest; PR descriptions, Discord/forum comments rank lower and require corroboration).All of the "concrete precedent" and anti-pattern examples are grounded in an actual review of PRs #15–#25 on this repo against a draft of this same file (spot-checking claims against
inavfirmware/Configurator source), not generic external advice.Test plan
npm run buildimpact.Assisted by Sonnet 5 using inav-claude, in accordance with AGENTS.md
https://claude.ai/code/session_01YbtjVLXNSuAxcW81c1SuiY