{"id":50500825,"url":"https://github.com/singi-labs/barazo-docs","last_synced_at":"2026-06-02T11:03:47.002Z","repository":{"id":340445572,"uuid":"1166074328","full_name":"singi-labs/barazo-docs","owner":"singi-labs","description":"Barazo documentation site (Fumadocs)","archived":false,"fork":false,"pushed_at":"2026-05-29T07:40:21.000Z","size":147,"stargazers_count":0,"open_issues_count":5,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2026-05-29T09:23:39.127Z","etag":null,"topics":["atprotocol","documentation","fumadocs","nextjs"],"latest_commit_sha":null,"homepage":"https://docs.barazo.forum","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/singi-labs.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":"AGENTS.md","dco":null,"cla":null}},"created_at":"2026-02-24T21:12:44.000Z","updated_at":"2026-05-29T07:40:23.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/singi-labs/barazo-docs","commit_stats":null,"previous_names":["barazo-forum/barazo-docs","singi-labs/barazo-docs"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/singi-labs/barazo-docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/singi-labs%2Fbarazo-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/singi-labs%2Fbarazo-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/singi-labs%2Fbarazo-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/singi-labs%2Fbarazo-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/singi-labs","download_url":"https://codeload.github.com/singi-labs/barazo-docs/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/singi-labs%2Fbarazo-docs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33818580,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-02T02:00:07.132Z","response_time":109,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["atprotocol","documentation","fumadocs","nextjs"],"created_at":"2026-06-02T11:03:46.087Z","updated_at":"2026-06-02T11:03:46.997Z","avatar_url":"https://github.com/singi-labs.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n\n\u003cpicture\u003e\n  \u003csource media=\"(prefers-color-scheme: dark)\" srcset=\"https://raw.githubusercontent.com/singi-labs/.github/main/assets/logo-dark.svg\"\u003e\n  \u003csource media=\"(prefers-color-scheme: light)\" srcset=\"https://raw.githubusercontent.com/singi-labs/.github/main/assets/logo-light.svg\"\u003e\n  \u003cimg alt=\"Barazo Logo\" src=\"https://raw.githubusercontent.com/singi-labs/.github/main/assets/logo-dark.svg\" width=\"120\"\u003e\n\u003c/picture\u003e\n\n# Barazo Docs\n\n**Documentation site for the Barazo forum platform.**\n\n[![Status: Alpha](https://img.shields.io/badge/status-alpha-orange)]()\n[![License: CC BY-SA 4.0](https://img.shields.io/badge/License-CC%20BY--SA%204.0-lightgrey.svg)](https://creativecommons.org/licenses/by-sa/4.0/)\n[![Code: MIT](https://img.shields.io/badge/Code-MIT-yellow.svg)](https://opensource.org/licenses/MIT)\n[![Node.js](https://img.shields.io/badge/node-24%20LTS-brightgreen)](https://nodejs.org/)\n[![TypeScript](https://img.shields.io/badge/typescript-5.x-blue)](https://www.typescriptlang.org/)\n\n\u003c/div\u003e\n\n---\n\n## Overview\n\nDeveloper and admin documentation for [Barazo](https://github.com/singi-labs), hosted at [docs.barazo.forum](https://docs.barazo.forum). Built with [Fumadocs](https://fumadocs.vercel.app/) (Next.js). API reference is auto-generated from the OpenAPI spec; TypeScript type docs are auto-generated from lexicon source files.\n\n---\n\n## Tech Stack\n\n| Component  | Technology                                           |\n| ---------- | ---------------------------------------------------- |\n| Framework  | Fumadocs (Next.js 16 / React 19 / TypeScript strict) |\n| Styling    | TailwindCSS                                          |\n| API docs   | fumadocs-openapi (auto-generated from OpenAPI spec)  |\n| Type docs  | fumadocs-typescript (auto-generated from source)     |\n| Search     | Orama (self-hosted, audience-scoped)                 |\n| Icons      | Phosphor Icons                                       |\n| Typography | Source Sans 3 / Source Code Pro (self-hosted)        |\n| Output     | Static export (zero server runtime)                  |\n\n---\n\n## Documentation Sections\n\n| Section            | Audience  | Description                                               |\n| ------------------ | --------- | --------------------------------------------------------- |\n| Getting Started    | Both      | Quickstart overview                                       |\n| Self-Hosting       | Admin     | Requirements, installation, configuration, upgrading      |\n| Admin Guide        | Admin     | Moderation, categories, customization, plugins            |\n| API Reference      | Developer | Auto-generated from OpenAPI spec (interactive playground) |\n| Lexicon Reference  | Developer | Auto-generated TypeScript type documentation              |\n| AT Protocol        | Developer | AT Protocol concepts for Barazo                           |\n| Plugin Development | Developer | Building and publishing plugins                           |\n| Contributing       | Developer | Contributing to Barazo                                    |\n| Migration          | Admin     | Migrating from other forum platforms                      |\n| FAQ                | Both      | Frequently asked questions                                |\n\nAudience-scoped sidebar tabs (Developer / Admin) provide separate navigation trees with scoped search.\n\n---\n\n## Quick Start\n\nPrerequisites: Node.js 24 LTS, pnpm.\n\n```bash\ngit clone https://github.com/singi-labs/barazo-docs.git\ncd barazo-docs\npnpm install\npnpm dev\n```\n\n---\n\n## Development\n\n```bash\npnpm dev          # Start dev server\npnpm build        # Static export\npnpm lint         # ESLint\npnpm typecheck    # TypeScript strict mode\n```\n\nSee [CONTRIBUTING.md](https://github.com/singi-labs/.github/blob/main/CONTRIBUTING.md) for contribution guidelines.\n\n**Key standards:**\n\n- Strict TypeScript -- `strict: true`, no `any`, no `@ts-ignore`\n- WCAG 2.2 AA accessibility from first commit\n- Static export -- all pages pre-rendered at build time\n- Auto-generated docs rebuild when barazo-api or barazo-lexicons update\n\n---\n\n## Auto-Generated Content\n\nTwo categories of documentation are generated at build time rather than written by hand:\n\n**API Reference** -- The Barazo API (barazo-api) generates an OpenAPI spec from its Zod validation schemas via `@fastify/swagger`. The `fumadocs-openapi` package converts this spec into interactive documentation pages with parameter tables, request/response schemas, code samples, and a live API playground.\n\n**Lexicon Type Docs** -- The `fumadocs-typescript` package reads TypeScript type definitions from barazo-lexicons and generates type documentation tables. Changes to lexicon schemas automatically update the docs on the next build.\n\n---\n\n## Related Repositories\n\n| Repository                                                         | Description                                        | License     |\n| ------------------------------------------------------------------ | -------------------------------------------------- | ----------- |\n| [barazo-api](https://github.com/singi-labs/barazo-api)             | AppView backend (Fastify, PostgreSQL, AT Protocol) | AGPL-3.0    |\n| [barazo-web](https://github.com/singi-labs/barazo-web)             | Forum frontend (Next.js, TailwindCSS)              | MIT         |\n| [barazo-lexicons](https://github.com/singi-labs/barazo-lexicons)   | AT Protocol schemas for forum data                 | MIT         |\n| [barazo-deploy](https://github.com/singi-labs/barazo-deploy)       | Docker Compose templates for self-hosting          | MIT         |\n| [barazo-website](https://github.com/singi-labs/barazo-website)     | Marketing site                             | Proprietary |\n| [barazo-workspace](https://github.com/singi-labs/barazo-workspace) | Project coordination and shared tooling            | MIT         |\n\n---\n\n## Community\n\n- **Website:** [barazo.forum](https://barazo.forum)\n- **Discussions:** [GitHub Discussions](https://github.com/orgs/singi-labs/discussions)\n- **Issues:** [Report bugs](https://github.com/singi-labs/barazo-docs/issues)\n\n---\n\n## License\n\nThis repository uses a dual license:\n\n**Content** (MDX documentation files in `content/`): **CC BY-SA 4.0**\n\n**Code** (Fumadocs configuration, components, layouts, build scripts): **MIT**\n\nSee [LICENSE](LICENSE) for the content license and [LICENSE-CODE](LICENSE-CODE) for the code license.\n\n---\n\nMade with ♥ in 🇪🇺 by [Singi Labs](https://singi.dev)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsingi-labs%2Fbarazo-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsingi-labs%2Fbarazo-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsingi-labs%2Fbarazo-docs/lists"}