Skip to content

Commit 3583299

Browse files
authored
Add public docs site scaffold (#216)
1 parent 6107a15 commit 3583299

55 files changed

Lines changed: 20966 additions & 0 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.github/workflows/docs.yml

Lines changed: 95 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,95 @@
1+
name: Docs
2+
3+
on:
4+
workflow_dispatch:
5+
push:
6+
branches: [main]
7+
paths:
8+
- ".github/workflows/docs.yml"
9+
- "docs-site/**"
10+
- "docs-content/**"
11+
- "scripts/docs/**"
12+
- "tests/docs/**"
13+
- "README.md"
14+
- "RELEASE_NOTES.md"
15+
- "src/row_bot/ui/**"
16+
- "src/row_bot/designer/**"
17+
- "src/row_bot/developer/**"
18+
- "src/row_bot/tools/**"
19+
- "src/row_bot/providers/**"
20+
- "src/row_bot/channels/**"
21+
- "src/row_bot/plugins/**"
22+
- "src/row_bot/mcp_client/**"
23+
- "bundled_skills/**"
24+
- "tool_guides/**"
25+
pull_request:
26+
paths:
27+
- ".github/workflows/docs.yml"
28+
- "docs-site/**"
29+
- "docs-content/**"
30+
- "scripts/docs/**"
31+
- "tests/docs/**"
32+
- "README.md"
33+
- "RELEASE_NOTES.md"
34+
- "src/row_bot/ui/**"
35+
- "src/row_bot/designer/**"
36+
- "src/row_bot/developer/**"
37+
- "src/row_bot/tools/**"
38+
- "src/row_bot/providers/**"
39+
- "src/row_bot/channels/**"
40+
- "src/row_bot/plugins/**"
41+
- "src/row_bot/mcp_client/**"
42+
- "bundled_skills/**"
43+
- "tool_guides/**"
44+
45+
concurrency:
46+
group: docs-${{ github.ref }}
47+
cancel-in-progress: true
48+
49+
permissions:
50+
contents: read
51+
52+
jobs:
53+
build:
54+
name: Build docs
55+
runs-on: ubuntu-latest
56+
env:
57+
NO_UPDATE_NOTIFIER: "1"
58+
steps:
59+
- name: Checkout
60+
uses: actions/checkout@v4
61+
62+
- name: Set up Python
63+
uses: actions/setup-python@v5
64+
with:
65+
python-version: "3.11"
66+
67+
- name: Install Python docs dependencies
68+
run: python -m pip install pyyaml pytest
69+
70+
- name: Collect docs inventory
71+
run: python scripts/docs/collect_inventory.py --out docs-build/inventory
72+
73+
- name: Validate docs metadata
74+
run: python scripts/docs/validate_public_docs.py
75+
76+
- name: Generate LLM docs files
77+
run: python scripts/docs/generate_llms_txt.py --docs-root docs-site/docs --out-dir docs-site/static
78+
79+
- name: Run docs automation tests
80+
run: pytest tests/docs -q
81+
82+
- name: Set up Node
83+
uses: actions/setup-node@v4
84+
with:
85+
node-version: "20"
86+
cache: npm
87+
cache-dependency-path: docs-site/package.json
88+
89+
- name: Install docs dependencies
90+
working-directory: docs-site
91+
run: npm ci
92+
93+
- name: Build docs site
94+
working-directory: docs-site
95+
run: npm run build:ci

.gitignore

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,10 @@ test-results/
3939
.backups/
4040
.copilot_backups/
4141
.local/
42+
docs-build/
43+
docs-site/.docusaurus/
44+
docs-site/build/
45+
docs-site/node_modules/
4246

4347
# Dev/test scripts
4448
seed_knowledge_graph.py
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
guides:
2+
install-row-bot:
3+
title: Install Row-Bot
4+
route: /docs/getting-started/installation
5+
sources:
6+
- README.md
7+
- installer/README.md
8+
first-launch:
9+
title: Complete First Launch Setup
10+
route: /docs/getting-started/first-launch
11+
sources:
12+
- src/row_bot/ui/setup_wizard.py
13+
create-workflow:
14+
title: Create A Workflow
15+
route: /docs/guides/workflows
16+
sources:
17+
- src/row_bot/ui/home.py
18+
- src/row_bot/tasks.py
19+
- bundled_skills/task_automation/SKILL.md
20+
use-designer:
21+
title: Use Designer Studio
22+
route: /docs/guides/designer-studio
23+
sources:
24+
- src/row_bot/designer/
25+
- bundled_skills/design_creator/SKILL.md
26+
use-developer:
27+
title: Use Developer Studio
28+
route: /docs/guides/developer-studio
29+
sources:
30+
- src/row_bot/developer/
31+
- bundled_skills/developer_coding/SKILL.md
32+
- bundled_skills/developer_review/SKILL.md
Lines changed: 127 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,127 @@
1+
screenshots:
2+
chat-main:
3+
title: Chat Main
4+
surface: chat
5+
status: planned
6+
output: chat-main.png
7+
alt: Row-Bot chat surface with sidebar, model picker, composer, and conversation area.
8+
chat-model-picker:
9+
title: Chat Model Picker
10+
surface: chat
11+
status: planned
12+
output: chat-model-picker.png
13+
alt: Row-Bot chat model picker showing provider-qualified model choices.
14+
chat-tool-trace:
15+
title: Chat Tool Trace
16+
surface: chat
17+
status: planned
18+
output: chat-tool-trace.png
19+
alt: Row-Bot chat transcript showing grouped tool activity.
20+
chat-approval:
21+
title: Chat Approval
22+
surface: chat
23+
status: planned
24+
output: chat-approval.png
25+
alt: Row-Bot approval dialog for a sensitive action.
26+
home-workflows:
27+
title: Workflows Home
28+
surface: home_workflows
29+
status: planned
30+
output: home-workflows.png
31+
alt: Row-Bot Home view open to the Workflows tab.
32+
designer-gallery:
33+
title: Designer Gallery
34+
surface: designer
35+
status: planned
36+
output: designer-gallery.png
37+
alt: Row-Bot Designer Studio gallery with design project cards.
38+
designer-new-project:
39+
title: Designer New Project
40+
surface: designer
41+
status: planned
42+
output: designer-new-project.png
43+
alt: Row-Bot Designer Studio new project dialog.
44+
designer-editor:
45+
title: Designer Editor
46+
surface: designer
47+
status: planned
48+
output: designer-editor.png
49+
alt: Row-Bot Designer Studio editor with chat, preview, and page controls.
50+
developer-home:
51+
title: Developer Home
52+
surface: developer
53+
status: planned
54+
output: developer-home.png
55+
alt: Row-Bot Developer Studio home showing workspaces and Custom Tools.
56+
developer-workspace:
57+
title: Developer Workspace
58+
surface: developer
59+
status: planned
60+
output: developer-workspace.png
61+
alt: Row-Bot Developer Studio workspace inspector.
62+
knowledge-graph:
63+
title: Knowledge Graph
64+
surface: knowledge
65+
status: planned
66+
output: knowledge-graph.png
67+
alt: Row-Bot Knowledge graph visualization and memory controls.
68+
settings-providers-overview:
69+
title: Settings Providers
70+
surface: settings
71+
status: planned
72+
output: settings-providers-overview.png
73+
alt: Row-Bot Settings dialog open to Providers.
74+
settings-models-catalog:
75+
title: Settings Models
76+
surface: settings
77+
status: planned
78+
output: settings-models-catalog.png
79+
alt: Row-Bot Settings dialog open to Models and Model Catalog.
80+
settings-knowledge:
81+
title: Settings Knowledge
82+
surface: settings
83+
status: planned
84+
output: settings-knowledge.png
85+
alt: Row-Bot Settings dialog open to Knowledge.
86+
settings-skills:
87+
title: Settings Skills
88+
surface: settings
89+
status: planned
90+
output: settings-skills.png
91+
alt: Row-Bot Settings dialog open to Skills.
92+
settings-channels:
93+
title: Settings Channels
94+
surface: settings
95+
status: planned
96+
output: settings-channels.png
97+
alt: Row-Bot Settings dialog open to Channels.
98+
settings-voice:
99+
title: Settings Voice
100+
surface: settings
101+
status: planned
102+
output: settings-voice.png
103+
alt: Row-Bot Settings dialog open to Voice.
104+
settings-mcp:
105+
title: Settings MCP
106+
surface: settings
107+
status: planned
108+
output: settings-mcp.png
109+
alt: Row-Bot Settings dialog open to MCP.
110+
settings-plugins:
111+
title: Settings Plugins
112+
surface: settings
113+
status: planned
114+
output: settings-plugins.png
115+
alt: Row-Bot Settings dialog open to Plugins.
116+
skills-hub-browse:
117+
title: Skills Hub Browse
118+
surface: skills_hub
119+
status: planned
120+
output: skills-hub-browse.png
121+
alt: Row-Bot Skills Hub browsing public skills.
122+
buddy-settings:
123+
title: Buddy Settings
124+
surface: buddy
125+
status: planned
126+
output: buddy-settings.png
127+
alt: Row-Bot Buddy settings for companion behavior and appearance.

docs-content/metadata/settings.yml

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
tabs:
2+
Providers:
3+
description: Connect hosted, subscription, local, cloud, and custom model providers.
4+
docs_route: /docs/configuration/models-and-providers
5+
screenshot_id: settings-providers-overview
6+
Models:
7+
description: Pin model Quick Choices, choose defaults, and review catalog metadata.
8+
docs_route: /docs/configuration/models-and-providers
9+
screenshot_id: settings-models-catalog
10+
Knowledge:
11+
description: Configure memory, document knowledge, graph review, embeddings, and wiki export.
12+
docs_route: /docs/ui-tour/
13+
screenshot_id: settings-knowledge
14+
Buddy:
15+
description: Configure companion behavior, look, overlay mode, and generated motion.
16+
docs_route: /docs/guides/channels-and-voice
17+
screenshot_id: buddy-settings
18+
Voice:
19+
description: Configure dictation, realtime talk, read-aloud, voice models, and diagnostics.
20+
docs_route: /docs/guides/channels-and-voice
21+
screenshot_id: settings-voice
22+
System:
23+
description: Configure workspace paths, app preferences, startup behavior, tunnel settings, logging, and updates.
24+
docs_route: /docs/reference/
25+
Tracker:
26+
description: Configure habit and health tracker views, charts, and logged data.
27+
docs_route: /docs/reference/
28+
Documents:
29+
description: Manage uploaded documents, document search, extraction, and vector indexing.
30+
docs_route: /docs/ui-tour/
31+
Search:
32+
description: Configure search providers, browser automation, and knowledge/search tools.
33+
docs_route: /docs/reference/
34+
Skills:
35+
description: Enable, disable, pin, browse, and review Smart Skills.
36+
docs_route: /docs/guides/skills-plugins-mcp
37+
screenshot_id: settings-skills
38+
Accounts:
39+
description: Connect account-level integrations used by tools and setup flows.
40+
docs_route: /docs/configuration/models-and-providers
41+
Channels:
42+
description: Configure Telegram, WhatsApp, Discord, Slack, SMS, delivery, and health checks.
43+
docs_route: /docs/guides/channels-and-voice
44+
screenshot_id: settings-channels
45+
Utilities:
46+
description: Configure built-in utility tools and system integrations.
47+
docs_route: /docs/reference/
48+
MCP:
49+
description: Add, test, import, browse, enable, and troubleshoot external MCP servers.
50+
docs_route: /docs/guides/skills-plugins-mcp
51+
screenshot_id: settings-mcp
52+
Plugins:
53+
description: Manage installed plugins, marketplace installs, and promoted Custom Tools.
54+
docs_route: /docs/guides/skills-plugins-mcp
55+
screenshot_id: settings-plugins

0 commit comments

Comments
 (0)