mirror of
https://github.com/andwati/zitadel.git
synced 2026-10-31 03:22:15 +00:00
docs: introduce versioned docs and migrate to fuma (#11166)
## Todos for release - [x] Configure Env in docs project on vercel - [x] Configure Root Path in the docs project on vercel - [ ] Remove old CSP https://github.com/zitadel/website/pull/1592 ## What we did This pull request migrates the project documentation from the old `docs/` directory to the new `apps/docs/` directory, introduces a new documentation system built with Next.js and Fumadocs, and updates all relevant references, configuration files, and documentation to reflect this change. It also adds new configuration and ignore files for the new documentation app, updates CI and linting to exclude the new docs from certain checks, and revises the contributing guidelines accordingly. **Documentation System Migration and New Docs App** * Migrated all documentation from `docs/` to `apps/docs/`, and updated all references in `README.md`, `CONTRIBUTING.md`, and other files to point to the new location. [[1]](diffhunk://#diff-eca12c0a30e25b4b46522ebf89465a03ba72a03f540796c979137931d8f92055L585-L640) [[2]](diffhunk://#diff-eca12c0a30e25b4b46522ebf89465a03ba72a03f540796c979137931d8f92055L660-R607) [[3]](diffhunk://#diff-eca12c0a30e25b4b46522ebf89465a03ba72a03f540796c979137931d8f92055L740-R687) [[4]](diffhunk://#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5L2-R3) [[5]](diffhunk://#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5L30-R30) * Added a new Next.js/Fumadocs-based documentation app under `apps/docs/`, including core app files, layouts, routing, search API, and a comprehensive `README.md` with development and contribution instructions. [[1]](diffhunk://#diff-5a1b07344a2c1b4d3f37b23ff1388b62cd9f57dea3c1cd23d8a0412b7602b132R1-R74) [[2]](diffhunk://#diff-462b9ad1eabbb7d1c29bb9c36e4931eb180fd7190900e6d2babf8f4d66ad1c28R1-R39) [[3]](diffhunk://#diff-e16ae25660ded787b10ac35dea96d5ecaacf895dae0afc8a9bd4382dc79a8c87R1-R7) [apps/docs/app/[[...slug]]/layout.tsxR1-R81](diffhunk://#diff-59e08acde4e805b7aeccef1dcf98f1d71dfc550777e6b9402085cee0e9fa4e0aR1-R81), [apps/docs/app/[[...slug]]/page.tsxR1-R79](diffhunk://#diff-e5df3f80d0fa01e12d63d81f29c57a9d14e846c78fd3beabb2ef768e38fd9580R1-R79), [[4]](diffhunk://#diff-389b34918e040cacaa87cd7201ffa462cc2b0b716736f537e3d3c660ac69353bR1-R7) [[5]](diffhunk://#diff-d3b03416d1c457b19f1c27b26f2db741412df841b875c26ccadc36e4522247f4R1-R29) [[6]](diffhunk://#diff-c8fb8339570a5305809be7c618e14705fd86390dc278e6ce8ba224a7bc8b0c3cR1-R25) **Configuration and Tooling Updates** * Updated `.github/workflows/codeql.yml`, `.golangci.yaml`, and `.github/dependabot.yml` to properly handle the new docs app: excluded `apps/docs` from certain checks, added npm dependency updates for the docs app, and excluded generated content. [[1]](diffhunk://#diff-12783128521e452af0cfac94b99b8d250413c516ec71fe6d97dbea666ff7ba27L8-R14) [[2]](diffhunk://#diff-9917ddc9f1c3304218f7269265b746d997c5c0615478177b5fceecd33ef47cb5R5-R6) [[3]](diffhunk://#diff-9917ddc9f1c3304218f7269265b746d997c5c0615478177b5fceecd33ef47cb5R126-R129) [[4]](diffhunk://#diff-dd4fbda47e51f1e35defb9275a9cd9c212ecde0b870cba89ddaaae65c5f3cd28R89-R106) * Updated `.devcontainer/devcontainer.json` to use the latest Go 1.25.3 version for consistency. **Licensing and Miscellaneous** * Added `apps/docs/` to the list of licensed directories in `LICENSING.md`. These changes ensure the documentation is now maintained in a modern, scalable system and all project tooling is updated to support the new structure. --------- Co-authored-by: Federico Coppede <[email protected]>
This commit is contained in:
Florian Forster
co-authored by
Federico Coppede
Federico Coppede
parent
7b6395c348
commit
d8ea041c56
@@ -0,0 +1,246 @@
|
||||
import type * as PageTree from 'fumadocs-core/page-tree';
|
||||
import {
|
||||
guidesSidebar,
|
||||
apisSidebar,
|
||||
legalSidebar,
|
||||
type SidebarItem,
|
||||
} from './sidebar-data';
|
||||
|
||||
export function buildCustomTree(originalTree: PageTree.Root, options?: { stripPrefix?: string, suppressWarnings?: boolean, labels?: Map<string, string> }): PageTree.Root {
|
||||
const start = performance.now();
|
||||
const pageLookup = new Map<string, PageTree.Item>();
|
||||
const folderLookup = new Map<string, PageTree.Folder>();
|
||||
|
||||
/**
|
||||
* 1. Normalizer
|
||||
*/
|
||||
function normalize(path: string): string {
|
||||
let p = path.toLowerCase();
|
||||
if (!p.startsWith('/')) p = '/' + p;
|
||||
|
||||
const prefix = options?.stripPrefix ?
|
||||
(options.stripPrefix.startsWith('/') ? options.stripPrefix : '/' + options.stripPrefix).toLowerCase()
|
||||
: undefined;
|
||||
|
||||
if (prefix) {
|
||||
if (p.startsWith(prefix)) {
|
||||
p = p.substring(prefix.length);
|
||||
}
|
||||
} else {
|
||||
p = p.replace(/^\/|docs\/|\/$/g, '');
|
||||
}
|
||||
|
||||
return p
|
||||
.replace(/^\//, '')
|
||||
.replace(/\/index$/, '')
|
||||
.replace(/_/g, '-');
|
||||
}
|
||||
|
||||
/**
|
||||
* 2. Collector
|
||||
*/
|
||||
function collect(node: PageTree.Node, path: string = '') {
|
||||
if (node.type === 'page') {
|
||||
const label = options?.labels?.get(node.url);
|
||||
if (label) node.name = label;
|
||||
pageLookup.set(node.url, node);
|
||||
pageLookup.set(normalize(node.url), node);
|
||||
}
|
||||
|
||||
if (node.type === 'folder') {
|
||||
const nodeName = typeof node.name === 'string' ? node.name : '';
|
||||
const currentPath = path ? `${path}/${nodeName}` : nodeName;
|
||||
|
||||
const sampleUrl = node.index?.url || node.children.find(c => c.type === 'page')?.url;
|
||||
if (sampleUrl) {
|
||||
const folderUrl = node.index ? sampleUrl : sampleUrl.split('/').slice(0, -1).join('/');
|
||||
folderLookup.set(normalize(folderUrl), node);
|
||||
folderLookup.set(folderUrl.replace(/^\/|docs\//, ''), node);
|
||||
}
|
||||
|
||||
if (node.index) {
|
||||
pageLookup.set(node.index.url, node.index);
|
||||
pageLookup.set(normalize(node.index.url), node.index);
|
||||
}
|
||||
|
||||
node.children.forEach(c => collect(c, currentPath));
|
||||
}
|
||||
}
|
||||
originalTree.children.forEach(c => collect(c));
|
||||
|
||||
/**
|
||||
* 3. Optimized Page Finder
|
||||
*/
|
||||
function findPage(path: string): PageTree.Item | undefined {
|
||||
if (!path) return undefined;
|
||||
const key = normalize(path);
|
||||
if (pageLookup.has(key)) return pageLookup.get(key);
|
||||
|
||||
const segments = key.split('/');
|
||||
if (segments.length >= 2 && segments[segments.length - 1] === segments[segments.length - 2]) {
|
||||
const dedupedKey = segments.slice(0, -1).join('/');
|
||||
if (pageLookup.has(dedupedKey)) return pageLookup.get(dedupedKey);
|
||||
}
|
||||
|
||||
for (const [lookupKey, node] of pageLookup.entries()) {
|
||||
if (lookupKey.endsWith('/' + key)) return node;
|
||||
}
|
||||
return undefined;
|
||||
}
|
||||
|
||||
/**
|
||||
* 4. Folder Finder
|
||||
*/
|
||||
function findFolder(dirName: string): PageTree.Folder | undefined {
|
||||
if (!dirName) return undefined;
|
||||
if (folderLookup.has(dirName)) return folderLookup.get(dirName);
|
||||
const normKey = normalize(dirName);
|
||||
if (folderLookup.has(normKey)) return folderLookup.get(normKey);
|
||||
|
||||
for (const [key, folder] of folderLookup.entries()) {
|
||||
if (key.includes(normKey)) return folder;
|
||||
}
|
||||
return undefined;
|
||||
}
|
||||
|
||||
/**
|
||||
* 5. Recursive Builder
|
||||
*/
|
||||
function buildNode(item: SidebarItem): PageTree.Node | PageTree.Node[] | null {
|
||||
if (typeof item === 'string') {
|
||||
const folder = findFolder(item);
|
||||
if (folder) {
|
||||
const indexPage = folder.index;
|
||||
const indexUrl = indexPage?.url;
|
||||
|
||||
const filteredChildren = folder.children.filter(child => {
|
||||
if (child.type === 'page' && indexUrl && child.url === indexUrl) return false;
|
||||
return true;
|
||||
});
|
||||
|
||||
return {
|
||||
type: 'folder',
|
||||
name: typeof folder.name === 'string' ? folder.name : item,
|
||||
index: indexPage,
|
||||
children: [...filteredChildren].sort((a, b) => {
|
||||
const nameA = typeof a.name === 'string' ? a.name : '';
|
||||
const nameB = typeof b.name === 'string' ? b.name : '';
|
||||
return nameA.localeCompare(nameB);
|
||||
}),
|
||||
} as PageTree.Folder;
|
||||
}
|
||||
|
||||
const page = findPage(item);
|
||||
if (page) return page;
|
||||
|
||||
if (!options?.suppressWarnings) {
|
||||
console.warn(`[Sidebar] Missing item: ${item}`);
|
||||
}
|
||||
return null;
|
||||
}
|
||||
|
||||
if (item.type === 'link') {
|
||||
const isExternal = item.href && (item.href.startsWith('http') || item.href.startsWith('//'));
|
||||
if (isExternal) {
|
||||
return {
|
||||
type: 'page',
|
||||
name: item.label || 'Link',
|
||||
url: item.href || '#',
|
||||
external: true,
|
||||
icon: item.icon
|
||||
} as PageTree.Item;
|
||||
}
|
||||
if (item.href) {
|
||||
const page = findPage(item.href);
|
||||
if (page) return { ...page, name: item.label || page.name, icon: item.icon };
|
||||
}
|
||||
return null;
|
||||
}
|
||||
|
||||
if (item.type === 'doc') {
|
||||
const node = findPage(item.id || '');
|
||||
if (!node) return null;
|
||||
return { ...node, name: item.label || node.name, icon: item.icon };
|
||||
}
|
||||
|
||||
if (item.type === 'autogenerated') {
|
||||
if (item.dirName) {
|
||||
const folder = findFolder(item.dirName);
|
||||
if (folder) {
|
||||
return [...folder.children].sort((a, b) => {
|
||||
const nameA = typeof a.name === 'string' ? a.name : '';
|
||||
const nameB = typeof b.name === 'string' ? b.name : '';
|
||||
return nameA.localeCompare(nameB);
|
||||
});
|
||||
}
|
||||
}
|
||||
return null;
|
||||
}
|
||||
|
||||
if (item.type === 'category' || !item.type) {
|
||||
let children: PageTree.Node[] = [];
|
||||
let promotedIndex: PageTree.Item | undefined;
|
||||
|
||||
if (item.items) {
|
||||
for (const child of item.items) {
|
||||
const built = buildNode(child);
|
||||
if (built) {
|
||||
if (!Array.isArray(built) && built.type === 'folder' && item.items.length === 1) {
|
||||
promotedIndex = built.index;
|
||||
children = built.children;
|
||||
} else if (Array.isArray(built)) {
|
||||
children.push(...built);
|
||||
} else {
|
||||
children.push(built);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return {
|
||||
type: 'folder',
|
||||
name: item.label || 'Category',
|
||||
children: children,
|
||||
defaultOpen: item.collapsed === false,
|
||||
// TS FIX: Check for link.id existence before calling findPage
|
||||
index: promotedIndex || (item.link?.type === 'doc' && item.link.id ? findPage(item.link.id) : undefined),
|
||||
icon: item.icon
|
||||
} as PageTree.Folder;
|
||||
}
|
||||
|
||||
return null;
|
||||
}
|
||||
|
||||
const newChildren: PageTree.Node[] = [];
|
||||
|
||||
const indexNode = findPage('index');
|
||||
if (indexNode) newChildren.push(indexNode);
|
||||
|
||||
guidesSidebar.forEach(item => {
|
||||
const node = buildNode(item);
|
||||
if (node && !Array.isArray(node)) newChildren.push(node);
|
||||
});
|
||||
|
||||
const apisFolder = buildNode({
|
||||
type: 'category',
|
||||
label: 'APIs',
|
||||
items: apisSidebar
|
||||
});
|
||||
if (apisFolder && !Array.isArray(apisFolder)) newChildren.push(apisFolder);
|
||||
|
||||
legalSidebar.forEach(item => {
|
||||
const node = buildNode(item);
|
||||
if (node && !Array.isArray(node)) newChildren.push(node);
|
||||
});
|
||||
|
||||
const end = performance.now();
|
||||
const duration = end - start;
|
||||
if (duration > 100) {
|
||||
console.log(`[CustomTree] Build time: ${duration.toFixed(2)}ms`);
|
||||
}
|
||||
|
||||
return {
|
||||
name: originalTree.name,
|
||||
children: newChildren
|
||||
};
|
||||
}
|
||||
@@ -0,0 +1,11 @@
|
||||
import type { BaseLayoutProps } from 'fumadocs-ui/layouts/shared';
|
||||
|
||||
|
||||
export function baseOptions(): BaseLayoutProps {
|
||||
return {
|
||||
nav: {
|
||||
title: 'ZITADEL Docs',
|
||||
},
|
||||
links: [],
|
||||
};
|
||||
}
|
||||
@@ -0,0 +1,15 @@
|
||||
import { createOpenAPI } from 'fumadocs-openapi/server';
|
||||
|
||||
import { globSync } from 'glob';
|
||||
|
||||
|
||||
const isDev = process.env.NODE_ENV === 'development';
|
||||
const globPattern = isDev ? 'openapi/latest/**/*.openapi.json' : 'openapi/**/*.openapi.json';
|
||||
|
||||
console.time('OpenAPI_Init');
|
||||
console.log(`[OpenAPI] Initializing... Mode: ${isDev ? 'DEV (Refined)' : 'PROD'}. Pattern: ${globPattern}`);
|
||||
|
||||
export const openapi = createOpenAPI({
|
||||
input: globSync(globPattern, { cwd: process.cwd(), absolute: true }),
|
||||
});
|
||||
console.timeEnd('OpenAPI_Init');
|
||||
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,45 @@
|
||||
import { docs, versions } from '../.source/server';
|
||||
import { type InferPageType, loader } from 'fumadocs-core/source';
|
||||
import { lucideIconsPlugin } from 'fumadocs-core/source/lucide-icons';
|
||||
|
||||
// See https://fumadocs.dev/docs/headless/source-api for more info
|
||||
export const source = loader({
|
||||
baseUrl: '/',
|
||||
source: docs.toFumadocsSource(),
|
||||
plugins: [lucideIconsPlugin()],
|
||||
});
|
||||
|
||||
export const versionSource = loader({
|
||||
baseUrl: '/',
|
||||
source: versions.toFumadocsSource(),
|
||||
plugins: [lucideIconsPlugin()],
|
||||
});
|
||||
|
||||
export function getPage(slugs: string[] | undefined) {
|
||||
const safeSlugs = slugs || [];
|
||||
// If the first slug matches a known version pattern (e.g., starts with 'v' and is in our list), use versionSource
|
||||
// For simplicity, we check if the page exists in versionSource first if it looks like a version
|
||||
if (safeSlugs.length > 0 && safeSlugs[0].startsWith('v')) {
|
||||
const page = versionSource.getPage(safeSlugs);
|
||||
if (page) return { page, source: versionSource };
|
||||
}
|
||||
|
||||
return { page: source.getPage(safeSlugs), source: source };
|
||||
}
|
||||
|
||||
export function getPageImage(page: InferPageType<typeof source>) {
|
||||
const segments = [...page.slugs, 'image.png'];
|
||||
|
||||
return {
|
||||
segments,
|
||||
url: `/og/docs/${segments.join('/')}`,
|
||||
};
|
||||
}
|
||||
|
||||
export async function getLLMText(page: InferPageType<typeof source>) {
|
||||
const processed = await page.data.getText('processed');
|
||||
|
||||
return `# ${page.data.title}
|
||||
|
||||
${processed}`;
|
||||
}
|
||||
Reference in New Issue
Block a user