-
Notifications
You must be signed in to change notification settings - Fork 369
docs: add Fumadocs documentation site #336
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -19,3 +19,4 @@ release | |
| .dev.vars.* | ||
| cloudflare/composio-broker/worker-configuration.d.ts | ||
| .claude/worktrees/ | ||
| .vercel/ | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| /node_modules | ||
| /.source | ||
| /coverage | ||
| /.next | ||
| /.open-next | ||
| /out | ||
| /build | ||
| /public/app-icon.svg | ||
| /public/screenshots | ||
| *.tsbuildinfo | ||
| .DS_Store | ||
| *.pem | ||
| .env*.local | ||
| .vercel | ||
| next-env.d.ts | ||
| cloudflare-env.d.ts | ||
| .env* |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| { | ||
| "$schema": "../../node_modules/oxlint/configuration_schema.json", | ||
| "ignorePatterns": [".next/**", ".open-next/**", ".source/**"] | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| <!-- BEGIN:nextjs-agent-rules --> | ||
|
|
||
| # This is NOT the Next.js you know | ||
|
|
||
| This version has breaking changes — APIs, conventions, and file structure may all differ from your training data. Read the relevant guide in `node_modules/next/dist/docs/` (resolved from this file's directory; in monorepos the `next` package may not be visible from the repo root) before writing any code. Heed deprecation notices. | ||
|
|
||
| This block is written and re-added by `next dev` — verify at `node_modules/next/dist/server/lib/generate-agent-files.js`. Removing it from a diff only re-creates the uncommitted change; committing it with your work keeps the tree clean. | ||
|
|
||
| <!-- END:nextjs-agent-rules --> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| @AGENTS.md |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,36 @@ | ||
| # OpenMausBot documentation | ||
|
|
||
| The public documentation site is a Next.js 16 + Fumadocs app. User-facing content lives in `content/docs`; the repository's top-level `docs` folder remains available for implementation notes and detailed platform records. | ||
|
|
||
| ## Develop | ||
|
|
||
| From the repository root: | ||
|
|
||
| ```bash | ||
| pnpm install | ||
| pnpm docs:dev | ||
| ``` | ||
|
|
||
| The site opens at `http://localhost:3000`. | ||
|
|
||
| ## Verify | ||
|
|
||
| ```bash | ||
| pnpm docs:build | ||
| pnpm --filter @openmausbot/docs types:check | ||
| pnpm --filter @openmausbot/docs lint | ||
| ``` | ||
|
|
||
| ## Deploy to Vercel | ||
|
|
||
| This is a fully static site. Deploying it does not deploy the Electron app, local harness, credentials, agents, or user data. | ||
|
|
||
| Create a second Vercel project beside the existing `openmausbot.com` project: | ||
|
|
||
| 1. Import the `milind-soni/OpenMausBot` repository. | ||
| 2. Set **Root Directory** to `apps/docs`. | ||
| 3. Keep the detected **Next.js** framework settings. | ||
| 4. Set the production branch to `main` and deploy. | ||
| 5. Add `docs.openmausbot.com` under **Settings → Domains**. | ||
|
|
||
| Vercel will build the static `out` directory, publish every push to `main`, and create preview URLs for documentation pull requests. Keep `openmausbot.com` on the existing marketing project and add a Docs link there after the new domain is live. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| import { source } from '@/lib/source'; | ||
| import { createFromSource } from 'fumadocs-core/search/server'; | ||
|
|
||
| export const revalidate = false; | ||
|
|
||
| export const { staticGET: GET } = createFromSource(source, { | ||
| language: 'english', | ||
| }); |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,56 @@ | ||
| import { getPageImageUrl, getPageMarkdownUrl, source } from '@/lib/source'; | ||
| import { | ||
| DocsBody, | ||
| DocsDescription, | ||
| DocsPage, | ||
| DocsTitle, | ||
| MarkdownCopyButton, | ||
| ViewOptionsPopover, | ||
| } from 'fumadocs-ui/layouts/docs/page'; | ||
| import { notFound } from 'next/navigation'; | ||
| import { getMDXComponents } from '@/components/mdx'; | ||
| import type { Metadata } from 'next'; | ||
| import { createRelativeLink } from 'fumadocs-ui/mdx'; | ||
| import { gitConfig } from '@/lib/shared'; | ||
|
|
||
| export default async function Page(props: PageProps<'/docs/[[...slug]]'>) { | ||
| const params = await props.params; | ||
| const page = source.getPage(params.slug); | ||
| if (!page) notFound(); | ||
|
|
||
| const MDX = page.data.body; | ||
| const markdownUrl = getPageMarkdownUrl(page).url; | ||
|
|
||
| return ( | ||
| <DocsPage toc={page.data.toc} full={page.data.full}> | ||
| <DocsTitle>{page.data.title}</DocsTitle> | ||
| <DocsDescription className="mb-0">{page.data.description}</DocsDescription> | ||
| <div className="flex items-center gap-2 border-b pb-6"> | ||
| <MarkdownCopyButton markdownUrl={markdownUrl} /> | ||
| <ViewOptionsPopover | ||
| markdownUrl={markdownUrl} | ||
| githubUrl={`https://github.com/${gitConfig.user}/${gitConfig.repo}/blob/${gitConfig.branch}/apps/docs/content/docs/${page.path}`} | ||
| /> | ||
| </div> | ||
| <DocsBody> | ||
| <MDX components={getMDXComponents({ a: createRelativeLink(source, page) })} /> | ||
| </DocsBody> | ||
| </DocsPage> | ||
| ); | ||
| } | ||
|
|
||
| export async function generateStaticParams() { | ||
| return source.generateParams(); | ||
| } | ||
|
|
||
| export async function generateMetadata(props: PageProps<'/docs/[[...slug]]'>): Promise<Metadata> { | ||
| const params = await props.params; | ||
| const page = source.getPage(params.slug); | ||
| if (!page) notFound(); | ||
|
|
||
| return { | ||
| title: page.data.title, | ||
| description: page.data.description, | ||
| openGraph: { images: getPageImageUrl(page).url }, | ||
| }; | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| import { source } from '@/lib/source'; | ||
| import { DocsLayout } from 'fumadocs-ui/layouts/docs'; | ||
| import { baseOptions } from '@/lib/layout.shared'; | ||
|
|
||
| export default function Layout({ children }: LayoutProps<'/docs'>) { | ||
| return ( | ||
| <DocsLayout tree={source.getPageTree()} {...baseOptions()}> | ||
| {children} | ||
| </DocsLayout> | ||
| ); | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,200 @@ | ||
| @import 'tailwindcss'; | ||
| @import 'fumadocs-ui/css/neutral.css'; | ||
| @import 'fumadocs-ui/css/preset.css'; | ||
|
|
||
| :root { | ||
| --omb-bg: #ffffff; | ||
| --omb-raised: #f7f8f8; | ||
| --omb-ink: #0a0a0b; | ||
| --omb-muted: #5f6570; | ||
| --omb-line: #e5e7ea; | ||
| --omb-accent: #009957; | ||
| --omb-accent-soft: #eaf8f1; | ||
|
|
||
| --color-fd-background: var(--omb-bg); | ||
| --color-fd-foreground: var(--omb-ink); | ||
| --color-fd-muted: var(--omb-raised); | ||
| --color-fd-muted-foreground: var(--omb-muted); | ||
| --color-fd-border: var(--omb-line); | ||
| --color-fd-primary: var(--omb-accent); | ||
| --color-fd-primary-foreground: #ffffff; | ||
| --color-fd-card: var(--omb-bg); | ||
| --color-fd-card-foreground: var(--omb-ink); | ||
| --color-fd-secondary: var(--omb-raised); | ||
| --color-fd-secondary-foreground: var(--omb-ink); | ||
| --color-fd-accent: var(--omb-accent-soft); | ||
| --color-fd-accent-foreground: #006b3d; | ||
| } | ||
|
|
||
| .dark { | ||
| --omb-bg: #070708; | ||
| --omb-raised: #131315; | ||
| --omb-ink: #f4f4f5; | ||
| --omb-muted: #9a9aa4; | ||
| --omb-line: #232327; | ||
| --omb-accent: #3fae6e; | ||
| --omb-accent-soft: #10271a; | ||
|
|
||
| --color-fd-primary-foreground: #07130c; | ||
| --color-fd-accent-foreground: #7bd69e; | ||
| } | ||
|
|
||
| html { | ||
| scrollbar-gutter: stable; | ||
| background: var(--omb-bg); | ||
| } | ||
|
|
||
| html > body[data-scroll-locked] { | ||
| margin-right: 0 !important; | ||
| --removed-body-scroll-bar-size: 0px !important; | ||
| } | ||
|
|
||
| body { | ||
| background: | ||
| radial-gradient(circle at 75% -20%, color-mix(in srgb, var(--omb-accent) 8%, transparent), transparent 32rem), | ||
| var(--omb-bg); | ||
| color: var(--omb-ink); | ||
| letter-spacing: -0.012em; | ||
| } | ||
|
|
||
| ::selection { | ||
| background: color-mix(in srgb, var(--omb-accent) 24%, transparent); | ||
| } | ||
|
|
||
| .omb-brand { | ||
| display: flex; | ||
| align-items: center; | ||
| gap: 0.65rem; | ||
| font-size: 0.9rem; | ||
| font-weight: 660; | ||
| letter-spacing: -0.02em; | ||
| } | ||
|
|
||
| .omb-brand img { | ||
| width: 1.65rem; | ||
| height: 1.65rem; | ||
| border-radius: 0.5rem; | ||
| } | ||
|
|
||
| .omb-brand-docs { | ||
| border-left: 1px solid var(--omb-line); | ||
| color: var(--omb-muted); | ||
| font-size: 0.78rem; | ||
| font-weight: 520; | ||
| letter-spacing: 0; | ||
| margin-left: 0.1rem; | ||
| padding-left: 0.7rem; | ||
| } | ||
|
|
||
| .omb-product-shot { | ||
| margin: 2rem 0; | ||
| } | ||
|
|
||
| .omb-product-shot-frame { | ||
| overflow: hidden; | ||
| border: 1px solid color-mix(in srgb, var(--omb-line) 88%, transparent); | ||
| border-radius: 1.25rem; | ||
| background: #0a0a0b; | ||
| box-shadow: | ||
| 0 1px 1px color-mix(in srgb, var(--omb-ink) 5%, transparent), | ||
| 0 22px 60px color-mix(in srgb, var(--omb-ink) 10%, transparent); | ||
| } | ||
|
|
||
| .omb-product-shot img { | ||
| display: block; | ||
| width: 100%; | ||
| max-height: 38rem; | ||
| object-fit: cover; | ||
| } | ||
|
|
||
| .omb-product-shot figcaption { | ||
| color: var(--omb-muted); | ||
| font-size: 0.78rem; | ||
| line-height: 1.5; | ||
| margin-top: 0.65rem; | ||
| text-align: center; | ||
| } | ||
|
|
||
| .omb-kicker { | ||
| color: var(--omb-accent); | ||
| font-size: 0.72rem; | ||
| font-weight: 700; | ||
| letter-spacing: 0.12em; | ||
| text-transform: uppercase; | ||
| } | ||
|
|
||
| .omb-lede { | ||
| color: var(--omb-muted); | ||
| font-size: 1.08rem; | ||
| line-height: 1.75; | ||
| max-width: 44rem; | ||
| } | ||
|
|
||
| .omb-stat-row { | ||
| display: grid; | ||
| grid-template-columns: repeat(3, minmax(0, 1fr)); | ||
| gap: 0.75rem; | ||
| margin: 1.75rem 0; | ||
| } | ||
|
|
||
| .omb-stat { | ||
| border: 1px solid var(--omb-line); | ||
| border-radius: 1rem; | ||
| background: color-mix(in srgb, var(--omb-raised) 78%, transparent); | ||
| padding: 1rem; | ||
| } | ||
|
|
||
| .omb-stat strong, | ||
| .omb-stat span { | ||
| display: block; | ||
| } | ||
|
|
||
| .omb-stat strong { | ||
| font-size: 1rem; | ||
| letter-spacing: -0.02em; | ||
| } | ||
|
|
||
| .omb-stat span { | ||
| color: var(--omb-muted); | ||
| font-size: 0.78rem; | ||
| margin-top: 0.2rem; | ||
| } | ||
|
|
||
| #nd-sidebar, | ||
| #nd-subnav { | ||
| background: color-mix(in srgb, var(--omb-bg) 92%, transparent); | ||
| backdrop-filter: blur(18px); | ||
| } | ||
|
|
||
| #nd-sidebar { | ||
| border-right-color: var(--omb-line); | ||
| } | ||
|
|
||
| #nd-subnav { | ||
| border-bottom-color: var(--omb-line); | ||
| } | ||
|
|
||
| .prose :where(h2, h3, h4) { | ||
| letter-spacing: -0.035em; | ||
| } | ||
|
|
||
| .prose :where(a:not([data-card])) { | ||
| text-decoration-color: color-mix(in srgb, var(--omb-accent) 45%, transparent); | ||
| text-underline-offset: 0.2em; | ||
| } | ||
|
|
||
| .prose :where(table) { | ||
| overflow: hidden; | ||
| border: 1px solid var(--omb-line); | ||
| border-radius: 0.9rem; | ||
| } | ||
|
|
||
| @media (max-width: 640px) { | ||
| .omb-stat-row { | ||
| grid-template-columns: 1fr; | ||
| } | ||
|
|
||
| .omb-product-shot-frame { | ||
| border-radius: 0.9rem; | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| import type { Metadata } from 'next'; | ||
| import { Inter } from 'next/font/google'; | ||
| import { Provider } from '@/components/provider'; | ||
| import './global.css'; | ||
|
|
||
| const inter = Inter({ subsets: ['latin'] }); | ||
|
|
||
| export const metadata: Metadata = { | ||
| metadataBase: new URL('https://docs.openmausbot.com'), | ||
| title: { | ||
| default: 'OpenMausBot Docs', | ||
| template: '%s · OpenMausBot Docs', | ||
| }, | ||
| description: 'Install, configure, and extend your local-first team of AI agents.', | ||
| openGraph: { | ||
| title: 'OpenMausBot Docs', | ||
| description: 'Your own team of AI agents, in a chat app.', | ||
| type: 'website', | ||
| }, | ||
| icons: { | ||
| icon: '/app-icon.svg', | ||
| apple: '/app-icon.svg', | ||
| }, | ||
| }; | ||
|
|
||
| export default function Layout({ children }: LayoutProps<'/'>) { | ||
| return ( | ||
| <html lang="en" className={inter.className} suppressHydrationWarning> | ||
| <body className="flex min-h-screen flex-col"> | ||
| <Provider>{children}</Provider> | ||
| </body> | ||
| </html> | ||
| ); | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| import { getLLMText, source } from '@/lib/source'; | ||
|
|
||
| export const revalidate = false; | ||
|
|
||
| export async function GET() { | ||
| const scanned = await Promise.all(source.getPages().map(getLLMText)); | ||
| return new Response(scanned.join('\n\n')); | ||
| } |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🔒 Security & Privacy | 🟡 Minor | ⚡ Quick win
Use a primary color pair with sufficient text contrast.
#009957with#ffffffhas about 3.7:1 contrast. This fails the 4.5:1 requirement for normal-size control labels. Darken--omb-accent, or use a darker primary foreground.Proposed fix
🤖 Prompt for AI Agents