Welcome to the GitHub project that powers the official OneBusAway Developer Documentation.
Want to help improve the documentation? Thank you! You can easily improve the official OneBusAway documentation by modifying the Markdown files that comprise it. We welcome any size of contribution, ranging from typos and corrected links, to brand-new tutorials.
From the root of the project, run the command bin/update_javadocs
to see a list of available projects from which Javadocs can be imported.
Ensure you have the following installed on your system:
Install the Windows Subsystem for Linux (WSL) if you haven't already.
After setting up WSL, navigate to the project directory in your Linux subsystem.
Fork the repository by clicking the "Fork" button on the repository page.
Clone the forked repository:
git clone https://github.com/YourUsername/onebusaway-docs.git
cd onebusaway-docs
Install dependencies:
bundle install
yarn install
If you encounter any errors, you may run:
yarn add glob
If CSS is not working properly, rebuild frontend assets:
bin/bridgetown frontend:build
Install dependencies:
bundle install
yarn install
To start the site in development mode, run:
bin/bridgetown start
Load the site up within a Ruby console (IRB)
bin/bridgetown console
Learn more: Bridgetown CLI Documentation
The website built from this project is deployed automatically to a static hosting service on Render. Please contact the maintainers with any questions.
Get Started
in the scope of Bug Report
.References/Closes/Fixes/Resolves #123
, where 123 is the issue number.Please note: maintainers may close your PR if it has gone stale or if we don't plan to merge the code.
This project exists because of all the people who have contributed.
We are all humans trying to work together to improve the community. Let's always be kind and appreciate the importance of making compromises. ❤️