Skip to content
robocup-docs

General

Thank you for your interest in contributing to the RoboCup documentation! This guide will help you get started.

Ways to Contribute

Section titled “Ways to Contribute”

Report Issues

Section titled “Report Issues”
  • Found a typo or error? Let us know!
  • Noticed outdated information? Please report it.
  • Have suggestions for improvement? We’d love to hear them.

Add or Improve Documentation

Section titled “Add or Improve Documentation”
  • Write new guides and tutorials
  • Expand existing sections with more detail
  • Add code examples and clarifications
  • Improve readability and organization

Share Resources

Section titled “Share Resources”
  • Recommend helpful YouTube channels
  • Suggest relevant papers or books
  • Share community tools and libraries
  • Contribute to the Resources section

Getting Started

Section titled “Getting Started”

Prerequisites

Section titled “Prerequisites”
  • GitHub account
  • Basic knowledge of Git
  • Familiarity with Markdown

Setting Up Your Environment

Section titled “Setting Up Your Environment”

  1. Fork the repository

    Terminal window
    # Navigate to the robocup-docs repository on GitHub and click "Fork"

  2. Clone your fork

    Terminal window
    git clone https://github.com/YOUR-USERNAME/robocup-docs.git
    cd robocup-docs

  3. Install dependencies

    Terminal window
    npm install
    npm install starlight-theme-flexoki

  4. Start the development server

    Terminal window
    npm run dev

Contribution Workflow

Section titled “Contribution Workflow”

1. Create a New Branch

Section titled “1. Create a New Branch”
Terminal window
git checkout -b feature/your-feature-name

Use descriptive branch names like:

  • docs/add-getting-started-guide
  • fix/typo-in-resources
  • docs/update-reference-section

2. Make Your Changes

Section titled “2. Make Your Changes”
  • Edit existing files or create new ones
  • Use Markdown for all documentation
  • Keep formatting consistent with existing pages
  • Add frontmatter with title and description

3. Preview Your Changes

Section titled “3. Preview Your Changes”

Visit http://localhost:3000 to see your changes in real-time

4. Commit Your Changes

Section titled “4. Commit Your Changes”
Terminal window
git add .
git commit -m "Add descriptive commit message"

Write clear commit messages explaining what changed and why.

5. Push to Your Fork

Section titled “5. Push to Your Fork”
Terminal window
git push origin feature/your-feature-name

6. Submit a Pull Request

Section titled “6. Submit a Pull Request”
  • Go to the main repository
  • Click “New Pull Request”
  • Select your branch
  • Describe your changes
  • Submit for review

Documentation Standards

Section titled “Documentation Standards”

File Naming

Section titled “File Naming”
  • Use lowercase with hyphens: my-guide.md
  • For ordered sections, prefix with numbers: 01-intro.md, 02-setup.md

Frontmatter

Section titled “Frontmatter”

Every markdown file should start with:

---
title: Your Page Title
description: A brief description of the page.
---

Formatting Guidelines

Section titled “Formatting Guidelines”
  • Use clear, concise language
  • Break content into logical sections with headings
  • Use code blocks for examples
  • Include links to related resources
  • Add alt text to all images

Structure

Section titled “Structure”
  • Guides: Step-by-step instructions for specific tasks
  • Reference: Technical information and specifications
  • About: General information and project details
  • Contributing: Information for contributors

Code of Conduct

Section titled “Code of Conduct”

Please be respectful and constructive in all interactions. This is a community project, and we value:

  • Respectful communication
  • Constructive feedback
  • Inclusivity and diversity
  • Collaboration over competition

Questions?

Section titled “Questions?”

If you have questions about contributing:

  • Check existing documentation
  • Review previous pull requests
  • Open an issue to discuss your ideas

Thank You!

Section titled “Thank You!”

Your contributions help make RoboCup documentation better for everyone. We appreciate your time and effort!