🤝 Welcome Contributors
Thank you for your interest in contributing to the TMS/DMS/CMS HOTAS Guide! This page provides all the technical documentation and workflows needed to contribute effectively to this project.
Quick Links:
📋 Project Management
Core Documentation
- Project Briefing – Complete project scope, structure, sources, and style rules
- Project Tracking – Current development status, WIP files, and roadmap
- Integrated Files Status – Repository tracking with commits, tags, and issues
- Setup Instructions – Guidelines for setting up the development environment
- Research Sources – Reference manuals and documents used in this guide (MEGA)
⚙️ Development Standards
Essential Standards
- WIP File Naming Convention – Standardized naming rules and status lifecycle
- Versioning System – Complete version numbering scheme (pre/post-publication)
- LaTeX Preamble Documentation – Technical specifications for LaTex document structure
🛠️ Tools & Utilities
Development Tools
- WIP Filename Generator – Interactive tool for generating compliant WIP file names
- Issues Dependency Map – Visual dependency diagram for active GitHub issues.
- Repository Overview – High-level map of the repository structure, workflows, and tooling.
- GitHub Codespaces – Ready-to-use cloud dev environment with LaTeX and all tools pre-installed.
- Read the Docs – Web version of the guide, auto-built from
docs-web/on every push. - GitBook – Visual Markdown editor synced with
docs-web/; use for reviewing and editing web content.
📊 Workflow Diagrams
Visual References
- WIP File Creation Workflow – Visual guide for creating new WIP files
- WIP Integration Flow Chart – Step-by-step integration process
- WIP File Life Cycle – Complete lifecycle from dev to approved
- Web Publication Flow – pandoc conversion pipeline: WIP chapter → docs-web/ → Read the Docs / GitBook
🗣️ Join the Conversation
Community & Discussion
- Falcon BMS Forum – Community discussion and feedback
- GitHub Discussions – Technical collaboration and Q&A
⚠️ Before Contributing
Please read:
- Review the Project Briefing to understand the project scope and goals
- Check the Project Tracking to see current status and avoid duplicate work
- Follow the WIP Naming Convention for all new files
- Use the Versioning System correctly when proposing version bumps