RAIL Lab Robot Documentation Site

This repository contains the documentation for the robots in The RAIL Lab. It is built using Docusaurus and is hosted on GitHub Pages.

🛠 Getting Started

1. Install Prerequisites

Ensure you have Node.js (v18 or later) and npm installed. You can install them from nodejs.org.

2. Clone the Repository

git clone https://github.com/raillab/rail-lab-robots.git
cd rail-lab-robots

3. Install Dependencies

npm install

4. Run Locally

To preview the documentation locally:

npm run start

Then visit http://localhost:3000 in your browser.

5. Make Changes

• All documentation is written in Markdown and lives in the docs/ folder.
• Each robot has its own folder inside docs/robots/
• After editing, commit your changes and push to GitHub.

6. Deployment

When changes are pushed to the main branch, the site is automatically deployed to GitHub Pages via GitHub Actions.

---

🧩 Contributing

If you notice something missing or want to contribute:

• Add new Markdown files or edit existing ones
• Use simple headings and code blocks when needed
• Follow the folder structure for consistency

For larger changes, create a GitHub issue or pull request first.

Thank you for helping document The RAIL Lab robots!