docs: restructure documentation following Diataxis framework#38
Merged
Conversation
Reorganise documentation into four distinct categories: **How-to Guides** (new `documentation/how-to/`): - integrate-servo-driver.md - add-custom-command.md - implement-safety-callbacks.md - deploy-to-nerves.md - use-urdf-with-ros.md - write-custom-sensor.md - troubleshoot-pubsub.md **Explanation** (expanded `documentation/topics/`): - Rename safety.md → understanding-safety.md with explanation focus - Add supervision-architecture.md - Add command-system.md - Add pubsub-system.md - Fix DSL examples in reactive-controllers.md **Reference** (new `documentation/reference/`): - message-types.md - error-types.md - telemetry-events.md **Other changes**: - Update mix.exs with `groups_for_extras` for ExDoc - Update README.md with organised documentation links - Fix cross-references after safety.md rename - Fix incorrect DSL examples (states, categories, controllers, sensors) - Document that errors should use `exception/1` not struct literals - Clarify BB.Message timestamp is monotonic time - Hide internal test sensor module from documentation
This was referenced Jan 18, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Reorganises documentation following the Diataxis framework with four distinct documentation types: Tutorials, How-to Guides, Explanation, and Reference.
Changes
New How-to Guides (
documentation/how-to/)Task-oriented guides for common operations:
integrate-servo-driver.md- Creating hardware driver packagesadd-custom-command.md- Extending the command systemimplement-safety-callbacks.md- Safe hardware shutdowndeploy-to-nerves.md- Embedded deployment with Igniteruse-urdf-with-ros.md- ROS integrationwrite-custom-sensor.md- Creating sensor modulestroubleshoot-pubsub.md- Debugging message flowExpanded Explanation (
documentation/topics/)safety.md→understanding-safety.mdwith explanation focussupervision-architecture.md- Why topology mirrors supervisioncommand-system.md- Goal → Feedback → Result patternpubsub-system.md- Hierarchical messagingNew Reference (
documentation/reference/)message-types.md- All BB.Message payload typeserror-types.md- All BB.Error types by classtelemetry-events.md- Observability eventsFixes
mix.exswithgroups_for_extrasfor proper ExDoc groupingREADME.mdwith organised documentation linkssafety.mdrenamestatessection (was incorrectly shown ascustom_statesin settings)categoryentities (was incorrectly shown ascategorieslist)controllers do/sensors dowrappers (were missing in several examples)exception/1not struct literals (for Splode backtrace capture)BB.Messagetimestamp is monotonic time, not wall-clockRelated
bb_liveviewandbb_kinodocumentation to follow