Skip to content

Removed reference to MSP docs project as it created a circular reference#11309

Open
daijoubu wants to merge 3 commits intoiNavFlight:maintenance-9.xfrom
daijoubu:fixMSPHeader
Open

Removed reference to MSP docs project as it created a circular reference#11309
daijoubu wants to merge 3 commits intoiNavFlight:maintenance-9.xfrom
daijoubu:fixMSPHeader

Conversation

@daijoubu
Copy link
Contributor

@daijoubu daijoubu commented Feb 3, 2026

User description

Removed the reference to https://github.com/xznhj8129/msp_documentation as it was pointing back to the MSP_REF.md document in iNavFlight/inav and reran the gen_docs.sh script.
Renamed MSP_REF.md to README.md so it will show as the readme for that directory.


PR Type

Bug fix


Description

  • Removed circular reference to external MSP documentation project

  • Fixed FEATURE_FW_AUTOTRIM enum value to use unsigned literal (1U << 31)

  • Corrected systemState_e source file reference from fc_init.h to fc_init.c

  • Fixed formatting issue in JSON file revision marker


Diagram Walkthrough

flowchart LR
  A["MSP Documentation Header"] -->|Remove circular ref| B["External docs link removed"]
  C["Enum Definitions"] -->|Fix unsigned literal| D["FEATURE_FW_AUTOTRIM corrected"]
  E["Source References"] -->|Correct file path| F["systemState_e source updated"]
Loading

File Walkthrough

Relevant files
Bug fix
docs_v2_header.md
Remove external MSP docs circular reference                           

docs/development/msp/docs_v2_header.md

  • Removed reference to external msp_documentation project that created
    circular dependency
  • Cleaned up documentation header to point only to official resources
+0/-1     
inav_enums.json
Fix enum values and source references                                       

docs/development/msp/inav_enums.json

  • Changed FEATURE_FW_AUTOTRIM value from "1 << 31" to "1U << 31" to use
    unsigned literal
  • Corrected systemState_e source file reference from fc_init.h to
    fc_init.c
+2/-2     
msp_ref.md
Remove external docs link and fix formatting                         

docs/development/msp/msp_ref.md

  • Removed reference to external msp_documentation project link
  • Fixed formatting of JSON file revision marker
+2/-2     
Documentation
inav_enums_ref.md
Update enum documentation and source paths                             

docs/development/msp/inav_enums_ref.md

  • Updated FEATURE_FW_AUTOTRIM documentation to reflect unsigned literal
    (1U << 31)
  • Corrected systemState_e source file path from fc_init.c to fc_init.h
    and vice versa for consistency
+3/-3     

@qodo-code-review
Copy link
Contributor

qodo-code-review bot commented Feb 3, 2026

PR Compliance Guide 🔍

All compliance sections have been disabled in the configurations.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant