Skip to content

docs: rename AGENT.md to AGENTS.md, fix stale/inaccurate content#11745

Merged
sensei-hacker merged 1 commit into
iNavFlight:maintenance-10.xfrom
sensei-hacker:docs-extract-agents-md
Jul 21, 2026
Merged

docs: rename AGENT.md to AGENTS.md, fix stale/inaccurate content#11745
sensei-hacker merged 1 commit into
iNavFlight:maintenance-10.xfrom
sensei-hacker:docs-extract-agents-md

Conversation

@sensei-hacker

Copy link
Copy Markdown
Member

Summary

  • Renames AGENT.md to AGENTS.md (the emerging convention; no internal references to the old filename found).
  • Fixes several inaccuracies found while verifying the file against current source:
    • The branching section claimed master was actively developed on and merged forward — corrected to describe it as a maintainer-maintained lagging mirror that contributors should never target or branch from (matches the corrected description landing in Development.md via docs: fix master-branch merge-flow error in Development.md, add git workflow guidance #11742).
    • Hardcoded version string ("9.0.1") replaced with a pointer to CMakeLists.txt's project(INAV VERSION ...), so it can't go stale again.
    • Removed an unsubstantiated "Follow MISRA C rules" claim — grepped the whole repo, there's no MISRA enforcement anywhere.
    • Fixed the gyroConfig_t parameter-group example (real fields are gyro_main_lpf_hz/kalman_q, not gyro_lpf_hz/gyro_kalman_q) and the DMA example (dmaGetByRef(), not a nonexistent dmaGetIdentifier()).
    • Added a "Development Documentation" section pointing at what's actually in docs/development/ today.

Test plan

  • Every claim above independently verified against current source (grep for internal AGENT.md references, CMakeLists.txt version, gyroConfig_t struct, dma.h function signatures, MISRA grep across the repo, recent merged PRs targeting master)
  • Docs-only change, no functional code touched

…ccuracies

- master is a maintainer-maintained lagging mirror, not "retired"
- version number no longer hardcoded (pointer to CMakeLists.txt instead)
- corrected the unsubstantiated MISRA C claim
- fixed gyroConfig_t/DMA example code to match real source
- added Development Documentation section pointing at docs/development/
@qodo-code-review

Copy link
Copy Markdown
Contributor

Qodo reviews are paused for this user.

Troubleshooting steps vary by plan Learn more →

On a Teams plan?
Reviews resume once this user has a paid seat and their Git account is linked in Qodo.
Link Git account →

Using GitHub Enterprise Server, GitLab Self-Managed, or Bitbucket Data Center?
These require an Enterprise plan - Contact us
Contact us →

@sensei-hacker
sensei-hacker merged commit 96ddd29 into iNavFlight:maintenance-10.x Jul 21, 2026
1 check failed
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.

1 participant