Skip to content

FT Autonomous Wiki — Initial Public Release

Latest
Latest

Choose a tag to compare

View all tags
@Cleavn17 Cleavn17 released this 29 Dec 09:07
· 26 commits to main since this release
v0.1.0
e49f776

FT Autonomous Wiki — Initial Public Release (v0.1.0)

This is the first official release of the Formula Trinity Autonomous Documentation Wiki.
It represents a complete, stable version of the documentation system that will be used by the team going forward.

What’s Included

Full documentation structure

  • Departments (Perception, State Estimation, Path Planning, Control, Hardware)
  • Tutorials (LiDAR setup, YOLO, SSH, simulation, etc.)
  • Resources (ROS2, Git, competition info, debugging)
  • Equipment descriptions
  • Software stack overview

Core features

  • Fully custom Material MkDocs theme
  • Light/Dark mode toggle
  • Search with highlighting
  • Dropdown navigation with scroll tracking
  • Image + video embedding
  • Local media folders per section
  • Last-updated timestamps via Git revision plugin
  • GitHub Pages deployment workflow

Why this Release Matters

This creates a frozen, versioned snapshot of the documentation website that reflects the 2025 team's work.
It ensures:

  • Stable archival for future members
  • Easy reference for judges, sponsors, and new recruits
  • A reliable baseline for future improvements

Future teams can build on this by releasing updated versions (e.g., v1.1, v2.0, etc.)

Notable technical components

  • mkdocs-material for UI/UX
  • mkdocs-git-revision-date-localized for last-updated dates
  • Custom CSS overrides
  • Automated GitHub Pages deployment
  • Clean repo structure designed for maintainability

Acknowledgements

This release includes major foundational work on:

  • Website architecture
  • Theme customization
  • Documentation style guide
  • Department-level structure
  • Tutorials and onboarding flow

Special thanks to everyone who contributed to building and refining the structure.

Next Steps for Contributors

  • Use this release as the baseline
  • Submit documentation updates via PRs
  • Tag future stable versions when major improvements are made

This marks the first full, stable version of the Formula Trinity Autonomous Wiki.
More improvements, refinements, and contributions will follow in future releases.

Assets 2
Loading