Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 32 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
name: Docs

on:
push:
branches: [main]
paths:
- 'docs/**'
pull_request:
paths:
- 'docs/**'

jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2

- name: Set up Node.js
uses: actions/setup-node@6044e13b5dc448c55e2357c09f80417699197238 # v6.2.0
with:
node-version: '20'
cache: 'npm'
cache-dependency-path: docs/package-lock.json

- name: Install dependencies
run: npm ci
working-directory: docs

- name: Build
run: npm run build
working-directory: docs
3 changes: 3 additions & 0 deletions .github/workflows/pypi.yml
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,9 @@ jobs:
run: uv build

- name: Publish to PyPI
# OIDC tokens are unavailable to pull requests from forks, so the
# dry-run publish can only run for same-repo branches and tag pushes.
if: github.ref_type == 'tag' || github.event.pull_request.head.repo.fork == false
working-directory: ./backend
run: |
uv publish --no-progress \
Expand Down
10 changes: 10 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,13 @@ helm/*/charts/**
backend/config.yml
backend/config.yaml
.ravnar_local

# Docs (Docusaurus)
docs/node_modules/
docs/build/
docs/.docusaurus/
docs/.cache-loader/

# Local agent / contributor playbook (not for the public repo)
AGENT.md
AGENTS.md
49 changes: 49 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
# Nebari Chat Pack Documentation

This directory contains the [Docusaurus](https://docusaurus.io/) site for the Nebari Chat pack. The site is written in TypeScript.

## Prerequisites

- Node.js `>= 20` (enforced by the `engines` field in `package.json`).
- npm (bundled with Node.js).

## Install

```bash
cd docs
npm install
```

## Local development

```bash
npm start
```

Starts the Docusaurus dev server with hot reload on http://localhost:3000/.

## Production build

```bash
npm run build
```

Emits static files to `docs/build/`. The search index is generated as part of the production build.

## Preview the production build

```bash
npm run serve
```

Serves the contents of `docs/build/` locally so you can verify the production output, including search.

## Type checking

```bash
npm run typecheck
```

## CI

The [`Docs` workflow](../.github/workflows/docs.yml) builds the site for every pull request and push to `main` that touches `docs/`.
14 changes: 14 additions & 0 deletions docs/docs/introduction.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
title: Introduction
description: Documentation for the Nebari Chat pack — deploy a chat interface on Nebari.
slug: /
sidebar_position: 1
last_update:
date: 2026-06-04
---

# Nebari Chat Pack

:::note[Documentation in progress]
This documentation site is being built out. Content is coming soon.
:::
119 changes: 119 additions & 0 deletions docs/docusaurus.config.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,119 @@
import {themes as prismThemes} from 'prism-react-renderer';
import type {Config} from '@docusaurus/types';
import type * as Preset from '@docusaurus/preset-classic';

const lightCodeTheme = prismThemes.github;
const darkCodeTheme = prismThemes.dracula;

const config: Config = {
title: 'Nebari Chat Pack',
tagline: 'Deploy a chat interface on Nebari',
favicon: 'img/favicon.ico',

future: {
v4: true,
},

url: 'https://nebari-dev.github.io',
baseUrl: '/nebari-chat-pack/',

organizationName: 'nebari-dev',
projectName: 'nebari-chat-pack',

onBrokenLinks: 'throw',

i18n: {
defaultLocale: 'en',
locales: ['en'],
},

markdown: {
mermaid: true,
},

themes: ['@docusaurus/theme-mermaid'],

plugins: [
[
require.resolve('@easyops-cn/docusaurus-search-local'),
{
indexBlog: false,
docsRouteBasePath: '/',
},
],
],

presets: [
[
'classic',
{
docs: {
routeBasePath: '/',
sidebarPath: './sidebars.ts',
sidebarCollapsible: true,
showLastUpdateTime: true,
editUrl:
'https://github.com/nebari-dev/nebari-chat-pack/edit/main/docs/docs/',
},
blog: false,
theme: {
customCss: './src/css/custom.css',
},
} satisfies Preset.Options,
],
],

themeConfig: {
colorMode: {
defaultMode: 'light',
disableSwitch: false,
respectPrefersColorScheme: true,
},
docs: {
sidebar: {
hideable: true,
autoCollapseCategories: true,
},
},
navbar: {
title: 'Nebari Chat Pack',
logo: {
alt: 'Nebari logo',
src: 'img/logo.svg',
},
items: [
{
href: 'https://github.com/nebari-dev/nebari-chat-pack',
label: 'GitHub',
position: 'right',
},
],
},
footer: {
style: 'dark',
links: [
{
title: 'Source',
items: [
{
label: 'GitHub',
href: 'https://github.com/nebari-dev/nebari-chat-pack',
},
{
label: 'Nebari',
href: 'https://nebari.dev',
},
],
},
],
copyright: `Copyright © ${new Date().getFullYear()} Nebari contributors.`,
},
prism: {
theme: lightCodeTheme,
darkTheme: darkCodeTheme,
additionalLanguages: ['bash', 'yaml', 'toml', 'python'],
},
} satisfies Preset.ThemeConfig,
};

export default config;
Loading
Loading