mirror of https://github.com/netbirdio/docs.git synced 2026-04-16 07:26:35 +00:00

Files

shuuri-labs f69c55b9c2 Streamlined site-to-site docs in new dedicated section. Removed old u… (#585 )

* Streamlined site-to-site docs in new dedicated section. Removed old use-case guide and added redirects

* restructure use-cases, move network use cases to network sections

* Reorganize network routes and networks documentation structure

- Restructure use cases into by-scenario and by-configuration folders
- Reorganize images to match new doc structure (concepts, by-scenario, by-resource-type)
- Add screenshots for site-to-site guides (home, office, cloud)
- Add policy screenshots for networks use cases
- Update site-to-site docs to use two separate policies instead of bidirectional
- Fix Access Control Groups to use correct destination groups
- Move "Self-Hosted vs Cloud" page to about section
- Update navigation and add redirects for moved pages
- Add CLAUDE.md for Claude Code guidance

* cleaned up network docs/image folder structure

* Align site-to-site use case links and redirects

Co-authored-by: Cursor <cursoragent@cursor.com>

* Update CLAUDE.md with accurate project details

Fix Next.js version (14 → 16), add React 19/Tailwind/Pages Router
details, document MDX page conventions, image paths, and note
absence of test suite.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

* Fix broken images and hydration error on networks page

- Restore 6 network index images accidentally deleted in 4116092
- Fix keycloak image filename typo (keycloack -> keycloak)
- Fix hydration mismatch by replacing invalid <p><div> nesting with <div>

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

* Fix 4 broken internal links found in PR review

- Fix missing by-scenario/ segment in site-to-site-home and
  site-to-site-office Tile hrefs (network-routes use-cases index)
- Fix lazy-connections typo to lazy-connection (implement-zero-trust)
- Update stale redirect link to direct path for access-control

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

---------

Co-authored-by: Jack Carter <128555021+SunsetDrifter@users.noreply.github.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>

2026-02-13 15:35:44 +01:00

3.1 KiB

Raw Blame History

CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

Project Overview

Documentation website for NetBird, an open-source WireGuard-based Zero Trust Networking platform. Built with Next.js 16 (Pages Router), React 19, MDX, and Tailwind CSS 3.

There is no test suite in this project. Validate changes with npm run build.

Common Commands

npm install          # Install dependencies
npm run dev          # Start dev server (also runs gen:llm)
npm run build        # Production build (also runs gen:llm)
npm run lint         # ESLint (next/core-web-vitals) on src/
npm run gen          # Regenerate API docs from NetBird OpenAPI spec
npm run gen:llm      # Regenerate LLM-friendly markdown (auto-runs with dev/build)

Architecture

Content Structure

Documentation pages are MDX files in src/pages/ using the Next.js Pages Router (not App Router). Key directories:

about-netbird/ - Conceptual docs
get-started/ - Installation and quickstart guides
manage/ - Feature documentation (peers, networks, DNS, access control, etc.)
selfhosted/ - Self-hosting deployment guides
ipa/ - API documentation (served at /api via rewrite)
use-cases/ - Tutorials and examples
client/ - Client configuration
help/ - Troubleshooting

MDX Page Conventions

Page title comes from the first # Heading in the MDX file
Optional export const description = '...' for meta description
Import components as needed: import {Note} from "@/components/mdx"
Images go in public/docs-static/img/<section>/ and are referenced as /docs-static/img/<section>/filename.png

src/components/NavigationDocs.jsx contains the docsNavigation array defining the sidebar. Must be updated when adding or moving pages. Supports nested links arrays for sub-navigation.

MDX Components

Custom components available in MDX files (see README.md for full usage examples):

Alert boxes: <Note>, <Warning>, <Success> (from @/components/mdx)
Layout: <Row>, <Col>, <Tiles> (from @/components/Tiles), <CodeGroup>
Media: <YouTube videoId="..."> (from @/components/YouTube)
UI: <Button> (from @/components/Button), <Badge>
API docs: <Properties>, <Property>

API Documentation Generator

generator/ - TypeScript generator that creates MDX pages from the NetBird OpenAPI spec
generator/templates/ApiTemplate.ts - Template for generated pages
Output: src/pages/ipa/resources/ (don't edit these files manually)

MDX Processing Pipeline

mdx/remark.mjs - Remark plugins
mdx/rehype.mjs - Rehype plugins (syntax highlighting via Shiki)
mdx/recma.mjs - Recma plugins

LLM Documentation

scripts/generate-llm-docs.mjs generates clean markdown to public/llms/ (gitignored)
Runs automatically with dev and build

URL Routing

Root / rewrites to /introduction
/api/* rewrites to /ipa/* (API docs live in src/pages/ipa/ but are served under /api)
Extensive legacy redirects from /docs/* and /how-to/* paths in next.config.mjs

3.1 KiB Raw Blame History