Skip to main content
BarodocBarodoc
GitHub
3 min read

Support

Community & Contributing

Join the Barodoc community and contribute to the project

Barodoc is an open-source project built by the community, for the community. There are many ways to get involved.

Where to Find Us

💻

GitHub

Source code, issues, and pull requests.

💬

Discussions

Questions, ideas, and community conversations.

🎮

Discord

Real-time chat with the team and community.

🐦

Twitter/X

Updates, tips, and announcements.

Reporting Bugs

Found a bug? Help us fix it by opening a GitHub issue with:

  1. Barodoc version — Run npx barodoc --version
  2. Node.js version — Run node --version
  3. Operating system — macOS, Linux, Windows
  4. Steps to reproduce — Minimal steps to trigger the bug
  5. Expected vs actual behavior — What should happen vs what does happen
  6. Error messages — Full error output or screenshots

Minimal reproduction

A minimal reproduction (a small project that demonstrates the bug) dramatically speeds up debugging. Consider creating a fresh project with pnpm create barodoc repro and adding only the steps needed to trigger the issue.

Requesting Features

We love hearing ideas! Open a GitHub Discussion with:

  • Problem — What are you trying to do?
  • Proposed solution — How would you solve it?
  • Alternatives — Other approaches you’ve considered
  • Context — Your use case and why this matters

Popular feature requests get promoted to issues and added to the roadmap.

Contributing Code

Getting Started

  1. Fork the repository on GitHub
  2. Clone your fork locally:
git clone https://github.com/YOUR_USERNAME/barodoc.git
cd barodoc
pnpm install
  1. Build all packages:
pnpm build:packages
  1. Start the docs dev server to test changes:
pnpm dev

Project Structure

packages/
├── barodoc/          # CLI (serve, build, create)
├── core/             # @barodoc/core - Astro integration
├── theme-docs/       # @barodoc/theme-docs - UI components
├── create-barodoc/   # Scaffolding CLI
├── plugin-sitemap/   # Sitemap generation
├── plugin-search/    # Pagefind search
├── plugin-rss/       # RSS feeds
├── plugin-pwa/       # Progressive Web App
├── plugin-og-image/  # OG image generation
├── plugin-openapi/   # API docs from OpenAPI
├── plugin-analytics/ # Analytics integrations
├── plugin-llms-txt/  # AI-readable summary
└── plugin-docsearch/ # Algolia DocSearch

Workflow

  1. Create a feature branch from main
  2. Make your changes with tests if applicable
  3. Run pnpm build:packages to verify the build
  4. Create a PR with a clear description
  5. Add a changeset if your change affects published packages:
pnpm changeset

Code Style

  • TypeScript for all packages
  • ESM modules (no CommonJS)
  • Astro components for server-rendered UI
  • React components for interactive islands

Contributing Documentation

Documentation improvements are always welcome. The docs site lives in docs/ and uses Full Custom Mode.

To work on docs:

pnpm dev        # Start docs dev server
pnpm build      # Test production build

Content files are in docs/src/content/docs/en/ (English) and docs/src/content/docs/ko/ (Korean).

Translation

We’re actively looking for translators! Currently supported:

  • English (en) — Primary language
  • Korean (ko) — Partial translation

To add a new locale, see the i18n guide.

Code of Conduct

We follow the Contributor Covenant code of conduct. Be respectful, inclusive, and constructive in all interactions.

Recognition

All contributors are recognized in the project’s README and release notes. Significant contributions may earn a “Core Contributor” role with write access to the repository.

Linked pages