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
44 changes: 44 additions & 0 deletions .github/workflows/docs-next.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
name: Build Docs (Next)

on:
pull_request:
paths:
- "docs-next/**"
- ".github/workflows/docs-next.yml"
push:
branches: [master]
paths:
- "docs-next/**"
- ".github/workflows/docs-next.yml"
workflow_dispatch:

jobs:
build:
runs-on: ubuntu-latest
defaults:
run:
working-directory: docs-next
steps:
- uses: actions/checkout@v6

- uses: pnpm/action-setup@v6
with:
version: 10

- uses: actions/setup-node@v6
with:
node-version: 24
cache: pnpm
cache-dependency-path: docs-next/pnpm-lock.yaml

- name: Install dependencies
run: pnpm install --frozen-lockfile

- name: Type check
run: pnpm types:check

- name: Lint
run: pnpm lint

- name: Build
run: pnpm build
26 changes: 26 additions & 0 deletions docs-next/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# deps
/node_modules

# generated content
.source

# test & build
/coverage
/.next/
/out/
/build
*.tsbuildinfo

# misc
.DS_Store
*.pem
/.pnp
.pnp.js
npm-debug.log*
yarn-debug.log*
yarn-error.log*

# others
.env*.local
.vercel
next-env.d.ts
47 changes: 47 additions & 0 deletions docs-next/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
# docs-next

This is a Next.js application generated with
[Create Fumadocs](https://github.com/fuma-nama/fumadocs).

It is a Next.js app with [Static Export](https://nextjs.org/docs/app/guides/static-exports) configured.

Run development server:

```bash
npm run dev
# or
pnpm dev
# or
yarn dev
```

Open http://localhost:3000 with your browser to see the result.

## Explore

In the project, you can see:

- `lib/source.ts`: Code for content source adapter, [`loader()`](https://fumadocs.dev/docs/headless/source-api) provides the interface to access your content.
- `lib/layout.shared.tsx`: Shared options for layouts, optional but preferred to keep.

| Route | Description |
| ------------------------- | ------------------------------------------------------ |
| `app/(home)` | The route group for your landing page and other pages. |
| `app/docs` | The documentation layout and pages. |
| `app/api/search/route.ts` | The Route Handler for search. |

### Fumadocs MDX

A `source.config.ts` config file has been included, you can customise different options like frontmatter schema.

Read the [Introduction](https://fumadocs.dev/docs/mdx) for further details.

## Learn More

To learn more about Next.js and Fumadocs, take a look at the following
resources:

- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js
features and API.
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
- [Fumadocs](https://fumadocs.dev) - learn about Fumadocs
34 changes: 34 additions & 0 deletions docs-next/biome.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
{
"$schema": "https://biomejs.dev/schemas/2.4.14/schema.json",
"vcs": {
"enabled": true,
"clientKind": "git",
"useIgnoreFile": true
},
"files": {
"ignoreUnknown": true,
"includes": ["**", "!node_modules", "!.next", "!dist", "!build", "!.source"]
},
"formatter": {
"enabled": true,
"indentStyle": "space",
"indentWidth": 2
},
"linter": {
"enabled": true,
"rules": {
"recommended": true
},
"domains": {
"next": "recommended",
"react": "recommended"
}
},
"assist": {
"actions": {
"source": {
"organizeImports": "on"
}
}
}
}
4 changes: 4 additions & 0 deletions docs-next/content/docs/api-reference/meta.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"title": "API Reference",
"pages": ["overview"]
}
10 changes: 10 additions & 0 deletions docs-next/content/docs/api-reference/overview.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: Overview
description: "Complete API surface."
---

import { Callout } from 'fumadocs-ui/components/callout';

<Callout title="Phase 1 stub" type="info">
Content port pending. See the [Zensical source](https://github.com/ByteVeda/taskito/tree/master/docs) for current text.
</Callout>
4 changes: 4 additions & 0 deletions docs-next/content/docs/architecture/meta.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"title": "Architecture",
"pages": ["overview"]
}
10 changes: 10 additions & 0 deletions docs-next/content/docs/architecture/overview.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: Overview
description: "How taskito is built end to end."
---

import { Callout } from 'fumadocs-ui/components/callout';

<Callout title="Phase 1 stub" type="info">
Content port pending. See the [Zensical source](https://github.com/ByteVeda/taskito/tree/master/docs) for current text.
</Callout>
10 changes: 10 additions & 0 deletions docs-next/content/docs/getting-started/concepts.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: Concepts
description: "Tasks, queues, workers, results, and how they fit together."
---

import { Callout } from 'fumadocs-ui/components/callout';

<Callout title="Phase 1 stub" type="info">
Content port pending. See the [Zensical source](https://github.com/ByteVeda/taskito/tree/master/docs) for current text.
</Callout>
10 changes: 10 additions & 0 deletions docs-next/content/docs/getting-started/installation.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: Installation
description: "Install taskito and prepare your environment."
---

import { Callout } from 'fumadocs-ui/components/callout';

<Callout title="Phase 1 stub" type="info">
Content port pending. See the [Zensical source](https://github.com/ByteVeda/taskito/tree/master/docs) for current text.
</Callout>
4 changes: 4 additions & 0 deletions docs-next/content/docs/getting-started/meta.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"title": "Getting Started",
"pages": ["installation", "quickstart", "concepts"]
}
10 changes: 10 additions & 0 deletions docs-next/content/docs/getting-started/quickstart.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: Quickstart
description: "Run your first task in five minutes."
---

import { Callout } from 'fumadocs-ui/components/callout';

<Callout title="Phase 1 stub" type="info">
Content port pending. See the [Zensical source](https://github.com/ByteVeda/taskito/tree/master/docs) for current text.
</Callout>
10 changes: 10 additions & 0 deletions docs-next/content/docs/guides/advanced-execution/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: Advanced execution
description: "Async tasks, native async, prefork pool, batching."
---

import { Callout } from 'fumadocs-ui/components/callout';

<Callout title="Phase 1 stub" type="info">
Content port pending. See the [Zensical source](https://github.com/ByteVeda/taskito/tree/master/docs) for current text.
</Callout>
4 changes: 4 additions & 0 deletions docs-next/content/docs/guides/advanced-execution/meta.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"title": "Advanced execution",
"pages": ["index"]
}
10 changes: 10 additions & 0 deletions docs-next/content/docs/guides/core/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: Core
description: "Core taskito features: tasks, queues, results."
---

import { Callout } from 'fumadocs-ui/components/callout';

<Callout title="Phase 1 stub" type="info">
Content port pending. See the [Zensical source](https://github.com/ByteVeda/taskito/tree/master/docs) for current text.
</Callout>
4 changes: 4 additions & 0 deletions docs-next/content/docs/guides/core/meta.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"title": "Core",
"pages": ["index"]
}
10 changes: 10 additions & 0 deletions docs-next/content/docs/guides/extensibility/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: Extensibility
description: "Middleware, custom serializers, interception."
---

import { Callout } from 'fumadocs-ui/components/callout';

<Callout title="Phase 1 stub" type="info">
Content port pending. See the [Zensical source](https://github.com/ByteVeda/taskito/tree/master/docs) for current text.
</Callout>
4 changes: 4 additions & 0 deletions docs-next/content/docs/guides/extensibility/meta.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"title": "Extensibility",
"pages": ["index"]
}
18 changes: 18 additions & 0 deletions docs-next/content/docs/guides/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
title: Guides
description: Topical guides covering taskito's surface area.
---

import { Cards, Card } from 'fumadocs-ui/components/card';

<Cards>
<Card title="Core" href="/docs/guides/core" />
<Card title="Reliability" href="/docs/guides/reliability" />
<Card title="Advanced execution" href="/docs/guides/advanced-execution" />
<Card title="Operations" href="/docs/guides/operations" />
<Card title="Observability" href="/docs/guides/observability" />
<Card title="Resources" href="/docs/guides/resources" />
<Card title="Workflows" href="/docs/guides/workflows" />
<Card title="Integrations" href="/docs/guides/integrations" />
<Card title="Extensibility" href="/docs/guides/extensibility" />
</Cards>
10 changes: 10 additions & 0 deletions docs-next/content/docs/guides/integrations/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: Integrations
description: "Flask, Django, FastAPI, OTel, Sentry, Prometheus."
---

import { Callout } from 'fumadocs-ui/components/callout';

<Callout title="Phase 1 stub" type="info">
Content port pending. See the [Zensical source](https://github.com/ByteVeda/taskito/tree/master/docs) for current text.
</Callout>
4 changes: 4 additions & 0 deletions docs-next/content/docs/guides/integrations/meta.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"title": "Integrations",
"pages": ["index"]
}
15 changes: 15 additions & 0 deletions docs-next/content/docs/guides/meta.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
{
"title": "Guides",
"pages": [
"index",
"core",
"reliability",
"advanced-execution",
"operations",
"observability",
"resources",
"workflows",
"integrations",
"extensibility"
]
}
10 changes: 10 additions & 0 deletions docs-next/content/docs/guides/observability/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: Observability
description: "Events, metrics, logs, OTel/Sentry/Prometheus."
---

import { Callout } from 'fumadocs-ui/components/callout';

<Callout title="Phase 1 stub" type="info">
Content port pending. See the [Zensical source](https://github.com/ByteVeda/taskito/tree/master/docs) for current text.
</Callout>
4 changes: 4 additions & 0 deletions docs-next/content/docs/guides/observability/meta.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"title": "Observability",
"pages": ["index"]
}
10 changes: 10 additions & 0 deletions docs-next/content/docs/guides/operations/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: Operations
description: "Workers, pause/resume, namespacing, scaling, deployment."
---

import { Callout } from 'fumadocs-ui/components/callout';

<Callout title="Phase 1 stub" type="info">
Content port pending. See the [Zensical source](https://github.com/ByteVeda/taskito/tree/master/docs) for current text.
</Callout>
4 changes: 4 additions & 0 deletions docs-next/content/docs/guides/operations/meta.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"title": "Operations",
"pages": ["index"]
}
10 changes: 10 additions & 0 deletions docs-next/content/docs/guides/reliability/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: Reliability
description: "Retries, timeouts, dead-lettering, circuit breakers."
---

import { Callout } from 'fumadocs-ui/components/callout';

<Callout title="Phase 1 stub" type="info">
Content port pending. See the [Zensical source](https://github.com/ByteVeda/taskito/tree/master/docs) for current text.
</Callout>
4 changes: 4 additions & 0 deletions docs-next/content/docs/guides/reliability/meta.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"title": "Reliability",
"pages": ["index"]
}
10 changes: 10 additions & 0 deletions docs-next/content/docs/guides/resources/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: Resources
description: "Worker DI: scopes, pools, hot reload, TOML config."
---

import { Callout } from 'fumadocs-ui/components/callout';

<Callout title="Phase 1 stub" type="info">
Content port pending. See the [Zensical source](https://github.com/ByteVeda/taskito/tree/master/docs) for current text.
</Callout>
4 changes: 4 additions & 0 deletions docs-next/content/docs/guides/resources/meta.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"title": "Resources",
"pages": ["index"]
}
10 changes: 10 additions & 0 deletions docs-next/content/docs/guides/workflows/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: Workflows
description: "DAG workflows, fan-out/fan-in, gates, sub-workflows."
---

import { Callout } from 'fumadocs-ui/components/callout';

<Callout title="Phase 1 stub" type="info">
Content port pending. See the [Zensical source](https://github.com/ByteVeda/taskito/tree/master/docs) for current text.
</Callout>
Loading
Loading