Welcome to the hexaFn project documentation hub. This file summarizes the structure and purpose of each document found in the docs/ directory.
- SUMMARY – High-level summary of all documentation files
- ARCHITECTURE – System design and internal architecture
- USE_CASES – Core problems the project addresses and examples
- CONTRIBUTING – Guidelines for contributing (issues, PRs, code)
- CODE_OF_CONDUCT – Community behavior rules
- PR_STRATEGY – Rules for naming, reviewing, and merging PRs
- COMMIT_STRATEGY – Commit message types and best practices
- BRANCH_STRATEGY – Naming and usage rules for git branches
- LABELLING_STRATEGY – System of issue/PR labels and their purpose
- PROJECT_STRUCTURE – Directory structure and module breakdown
- MILESTONES – Key milestones and development phases
- PROJECT_BOARD – GitHub Projects board usage guide
- ROADMAP – Development roadmap and release strategy
- CONFIGURATION – Runtime and environment settings
- STYLE_GUIDE – Coding conventions and formatting rules
- GETTING_STARTED – Setup instructions for new devs
- HEXAGONAL_ARCHITECTURE_GUIDE - Protocol-agnostic implementation patterns and data flow
- DEVELOPMENT_GUIDE – In-depth dev guide
- FAQ – Frequently asked questions
- DATA_MODEL_CORE – Core data model definitions
- DATA_MODEL_BRIDGE – Bridge module data model
- DATA_MODEL_TRIGGER – Trigger module data model
- DATA_MODEL_RUN – Run module data model
- DATA_MODEL_STORE – Store module data model
- DATA_MODEL_CAST – Cast module data model
- DATA_MODEL_WATCH – Watch module data model
- DATA_FLOW – High-level data flow across modules
- DATA_FLOW_SAMPLE – Sample data flow illustrating the 6F Lifecycle Flow
- DATA_FLOW_DETAIL – Detailed component and interface data flow
- RUST_PORTS_ADAPTERS_EXAMPLE – Complete mapping of ports, adapters, and domain components
- COMMUNITY – Community engagement and interaction rules
- CONTACT – How to reach maintainers or report issues
- SUPPORT – How to get help and where to ask questions
- BRANDING – Visual identity and logo usage
- CNAME – Custom domain for GitHub Pages
- Web Site – Landing page of documentation site
This summary will help you navigate the docs efficiently and understand their purpose in the project lifecycle.