Skip to content

Commit ddf8f40

Browse files
committed
docs: add cross-references to key documentation files
- Add "Additional Documentation" section to README.md with links to FAQ, CUSTOMIZING_CONFIGURATION_STEPS, GOVERNANCE, SECURITY, COMPLIANCE, and ROADMAP - Expand "Learning the Code" section in CONTRIBUTING.md with links to GOVERNANCE, CUSTOMIZING_CONFIGURATION_STEPS, and ROADMAP - Add "Related Documents" section to CODE_OF_CONDUCT.md linking to GOVERNANCE and SECURITY policies - Improve FAQ link formatting in SUPPORT.md This improves documentation discoverability and helps users and contributors navigate to relevant resources based on their needs.
1 parent 38cb198 commit ddf8f40

4 files changed

Lines changed: 21 additions & 1 deletion

File tree

CODE_OF_CONDUCT.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,14 @@ In addition, the rules regarding weaponization and manned vehicles using
9999
ArduPilot apply regardless of whether you are representing the ArduPilot
100100
project at the time.
101101

102+
Related Documents
103+
-----------------
104+
105+
For more information about the project governance and security practices, see:
106+
107+
- [Project Governance](https://ardupilot.github.io/MethodicConfigurator/GOVERNANCE.html)
108+
- [Security Policy](https://ardupilot.github.io/MethodicConfigurator/SECURITY.html)
109+
102110
Enforcement
103111
-----------
104112

CONTRIBUTING.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,9 @@ and also:
2121

2222
* [System requirements](https://ardupilot.github.io/MethodicConfigurator/SYSTEM_REQUIREMENTS.html)
2323
* [Compliance](https://ardupilot.github.io/MethodicConfigurator/COMPLIANCE.html), including our [Coding Standards](https://ardupilot.github.io/MethodicConfigurator/COMPLIANCE.html#coding-standards)
24+
* [Project Governance](https://ardupilot.github.io/MethodicConfigurator/GOVERNANCE.html) - understand how the project is managed and decisions are made
25+
* [Customizing Configuration Steps](https://ardupilot.github.io/MethodicConfigurator/CUSTOMIZING_CONFIGURATION_STEPS.html) - extend the configuration workflow
26+
* [Project Roadmap](https://ardupilot.github.io/MethodicConfigurator/ROADMAP.html) - see what we're planning to work on
2427

2528
## Setting up developer environment
2629

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -277,6 +277,15 @@ Need [help or support](https://ardupilot.github.io/MethodicConfigurator/SUPPORT.
277277
There is also [documentation on other use cases](https://ardupilot.github.io/MethodicConfigurator/USECASES.html)
278278
and a detailed but generic [Usermanual](https://ardupilot.github.io/MethodicConfigurator/USERMANUAL.html).
279279

280+
**Additional Documentation:**
281+
282+
- [Frequently Asked Questions (FAQ)](https://ardupilot.github.io/MethodicConfigurator/FAQ.html)
283+
- [Customizing Configuration Steps](https://ardupilot.github.io/MethodicConfigurator/CUSTOMIZING_CONFIGURATION_STEPS.html) - for advanced users and integrators
284+
- [Project Governance](https://ardupilot.github.io/MethodicConfigurator/GOVERNANCE.html) - how decisions are made
285+
- [Security Policy](https://ardupilot.github.io/MethodicConfigurator/SECURITY.html) - reporting vulnerabilities
286+
- [Compliance](https://ardupilot.github.io/MethodicConfigurator/COMPLIANCE.html) - standards and regulations
287+
- [Roadmap](https://ardupilot.github.io/MethodicConfigurator/ROADMAP.html) - planned features and improvements
288+
280289
## Contributing
281290

282291
Want [to help us and contribute](https://github.com/ArduPilot/MethodicConfigurator/blob/master/CONTRIBUTING.md)?

SUPPORT.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ To help yourself, read the extensive documentation:
1414
[plane](https://ardupilot.github.io/MethodicConfigurator/TUNING_GUIDE_ArduPlane.html),
1515
[rover](https://ardupilot.github.io/MethodicConfigurator/TUNING_GUIDE_Rover.html),
1616
[heli](https://ardupilot.github.io/MethodicConfigurator/TUNING_GUIDE_Heli.html)
17-
* [FAQ](https://ardupilot.github.io/MethodicConfigurator/FAQ.html) Frequently asked questions
17+
* [Frequently Asked Questions (FAQ)](https://ardupilot.github.io/MethodicConfigurator/FAQ.html)
1818
* [Glossary](https://ardupilot.github.io/MethodicConfigurator/USERMANUAL.html#glossary)
1919
* [System requirements](https://ardupilot.github.io/MethodicConfigurator/SYSTEM_REQUIREMENTS.html)
2020
* [Software architecture](https://ardupilot.github.io/MethodicConfigurator/ARCHITECTURE.html)

0 commit comments

Comments
 (0)