This repository contains the documentation website for BLine.
Looking for the actual code? See BLine-Lib and BLine-GUI.
BLine is an open-source path generation and tracking suite designed for holonomic drivetrains (swerve, mecanum, etc.) in FRC. Built by students for students, it prioritizes simplicity and performance in time-constrained environments where quick iteration and rapid empirical testing prove advantageous.
| Component | Description | Repository |
|---|---|---|
| BLine-GUI | Visual path planning interface with real-time simulation | GitHub |
| BLine-Lib | Java library for FRC robots with path-following algorithm | GitHub |
- 97% reduction in path computation time vs PathPlanner
- 66% reduction in cross-track error at waypoints
- No precomputation required — paths execute immediately
- Quick, forgiving and easy controller tuning — works well even when sub-optimally tuned
- Python 3.9+
- pip or pipx
# Clone the repository
git clone https://github.com/edanliahovetsky/BLine-Docs.git
cd BLine-Docs
# Create a virtual environment (recommended)
python -m venv venv
source venv/bin/activate # On Windows: venv\Scripts\activate
# Install dependencies
pip install -r requirements.txtmkdocs serveOpen http://127.0.0.1:8000 in your browser.
mkdocs buildThe static site will be generated in the site/ directory.
BLine-Docs/
├── docs/ # Documentation source files
│ ├── index.md # Homepage
│ ├── getting-started/ # Installation & quick start guides
│ ├── concepts/ # Core concepts (elements, constraints, etc.)
│ ├── gui/ # GUI documentation
│ ├── lib/ # Library documentation
│ ├── assets/ # Images and GIFs
│ │ └── gifs/ # Demo GIFs organized by section
│ ├── stylesheets/ # Custom CSS
│ └── javascripts/ # Custom JavaScript
├── overrides/ # MkDocs theme overrides
├── mkdocs.yml # MkDocs configuration
├── requirements.txt # Python dependencies
└── site/ # Generated static site (gitignored in production)
Contributions to improve the documentation are welcome!
- Fork the repository
- Create a feature branch (
git checkout -b improve-docs) - Make your changes
- Test locally with
mkdocs serve - Submit a pull request
- Use clear, concise language
- Include code examples where helpful
- Add GIFs for visual features (place in
docs/assets/gifs/) - Follow the existing structure and formatting
- BLine-Lib on GitHub — Java library source code
- BLine-GUI on GitHub — GUI application source code
- Full Javadoc — API reference
- Chief Delphi Discussion — Community discussion thread
BLine is released under the BSD 3-Clause License.