Skip to content

BC-Robotics-4504/bcr-docs

Repository files navigation

BCR 4504 Team Documentation

CI License Built with Starlight

Welcome to the official documentation site for FRC Team BCR 4504. This site contains resources, guides, and reference material for our team members, mentors, and supporters.


📂 Project Structure

Our documentation site follows a clear and organized file structure for easy collaboration:

.
├── public/ # Static assets served as-is (e.g., favicon, robots.txt)
├── src/
│ ├── assets/ # Images, diagrams, and other media used in docs
│ ├── content/
│ │ └── docs/ # Main documentation content (.md or .mdx files)
│ └── content.config.ts # Content collection configuration
├── astro.config.mjs # Astro configuration file
├── package.json # Project metadata and dependencies
└── tsconfig.json # TypeScript configuration

Key points:

  • Documentation pages are stored in src/content/docs/.
  • Images and diagrams go in src/assets/ and can be referenced in Markdown.
  • Anything in public/ is served directly without processing.

Contributing

  1. Clone the repo with git clone https://github.com/BC-Robotics-4504/bcr-docs
  2. Checkout a new branch with git switch -c {feature_name}
  3. Submit a pull-request to have your contribution merged onto the master branch.

🙌 Credits

We’d like to thank the following projects and services that make this documentation possible:

  • Astro — For the static site framework.
  • Starlight — For the documentation theme.