Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
69a925f
adding files for documentation and website.
killua156 May 15, 2026
9131f88
Update documentation and styles for Nebari Ray Serve Pack
killua156 May 15, 2026
57e4f86
feat(docs): initialize Docusaurus documentation site
killua156 May 15, 2026
6ef9e7d
fix(docs): update Docusaurus config for markdown path and edit URL
killua156 May 15, 2026
f33207b
feat(docs): enhance documentation for deploying Ray Serve and update …
killua156 May 15, 2026
49ed1a7
docs: apply editorial fixes and use official Nebari logo
killua156 May 19, 2026
d53af89
docs: drop unused TypeScript scaffolding and fix Edit URL
killua156 May 19, 2026
1847cdf
docs: restructure site to mirror nebari-docs Diátaxis layout
killua156 May 19, 2026
1243ccb
docs: add search and explicit light/dark toggle
killua156 May 19, 2026
091b705
docs: address review feedback
killua156 May 20, 2026
7f75326
docs: deploy via Netlify and migrate to yarn
killua156 May 21, 2026
68ff330
docs: add demo screenshots and align with observed behavior
killua156 May 22, 2026
a6bea81
docs: address review feedback - separate end-user from operator content
killua156 May 22, 2026
3536fde
docs: tighten content from second-pass review
killua156 May 26, 2026
17b0f8d
docs: style color-mode toggle to match Nebari UI
killua156 May 26, 2026
406a102
docs: add AGENT.md playbook for docs-site maintenance
killua156 May 26, 2026
8a3573d
chore: untrack AGENT.md; keep as local playbook only
killua156 May 26, 2026
2e86b91
docs: replace full docs with placeholder landing page
killua156 Jun 8, 2026
b9c17b8
docs: remove all Netlify references
killua156 Jun 10, 2026
5dbafff
Remove note, troubleshooting and deployment boilerplate from docs README
killua156 Jun 11, 2026
ed3737c
Convert docs to TypeScript and simplify workflow to match nebi
killua156 Jun 12, 2026
4e126cd
Deploy docs to GitHub Pages and drop yarn gitignore entries
killua156 Jun 18, 2026
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
56 changes: 56 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
name: Docs

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

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

- 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

- name: Upload build artifact
uses: actions/upload-pages-artifact@56afc609e74202658d3ffba0e8f6dda462b719fa # v3.0.1
with:
path: docs/build

deploy:
name: Deploy to GitHub Pages
needs: build
if: github.ref == 'refs/heads/main'
permissions:
pages: write
id-token: write
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@d6db90164ac5ed86f2b6aed7e0febac5b3c0c03e # v4.0.5
19 changes: 19 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,22 @@ chart/Chart.lock

# Dev environment
dev/.cache/

# 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

# Misc
.DS_Store
.env.local
.env.development.local
.env.test.local
.env.production.local

npm-debug.log*
49 changes: 49 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
# Nebari Ray Serve Pack Documentation

This directory contains the [Docusaurus](https://docusaurus.io/) site for the Nebari Ray Serve 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 Ray Serve pack — deploy Ray Serve on Nebari.
slug: /
sidebar_position: 1
last_update:
date: 2026-06-04
---

# Nebari Ray Serve 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 Ray Serve Pack',
tagline: 'Deploy Ray Serve on Nebari',
favicon: 'img/favicon.ico',

future: {
v4: true,
},

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

organizationName: 'nebari-dev',
projectName: 'nebari-rayserve-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-rayserve-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 Ray Serve Pack',
logo: {
alt: 'Nebari logo',
src: 'img/logo.svg',
},
items: [
{
href: 'https://github.com/nebari-dev/nebari-rayserve-pack',
label: 'GitHub',
position: 'right',
},
],
},
footer: {
style: 'dark',
links: [
{
title: 'Source',
items: [
{
label: 'GitHub',
href: 'https://github.com/nebari-dev/nebari-rayserve-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