Add documentation authoring pipeline and initial doc pages#5
Merged
Aaronontheweb merged 61 commits intodevfrom May 5, 2026
Merged
Add documentation authoring pipeline and initial doc pages#5Aaronontheweb merged 61 commits intodevfrom
Aaronontheweb merged 61 commits intodevfrom
Conversation
Defines a repeatable per-page process for writing netclaw.dev docs: page type identification, information gathering from source repo and screenshots, structured interview protocol, page templates by type (CLI reference, tutorial, guide, concept), screenshot integration guide, and quality checklist.
- Add docs-queue.md checklist (45 pages in 8 batches) - Add scripts/write-docs.sh for batch doc generation - Split providers into managed-providers and self-hosted-providers - Replace reverse-proxy with exposure-modes (Tailscale/Cloudflare) - Add Notifications & Observability section (operational-alerts, opentelemetry) - Remove setting-up-ollama guide (link to external docs instead) - Update CLAUDE.md with full 9-step authoring workflow
- Replace inline prompt template with .prose/write-doc-page.prose workflow - 6-stage pipeline: research → draft → parallel critique (3 agents) → revise → visual verify → commit - Add scripts/screenshot-page.mjs for Playwright-based page screenshot capture - Update .gitignore for docs-logs/ and OpenProse runtime state
Bash ((x++)) returns exit code 1 when x is 0, which set -e interprets as failure. Use $((x + 1)) instead.
Port 4322 was hardcoded and conflicted with other servers, causing the Playwright process to hang indefinitely. Now finds a free port automatically and kills everything after 60 seconds.
Avoids process hangs from the screenshot script. Falls back gracefully if dev server or Playwright MCP isn't available.
- security-model: remove incorrect "not yet supported" claim for per-channel audience overrides (ChannelAudiences is implemented), add TODO for screenshot placeholder - security-model: replace blanket config/ deny claim with specific denied paths (secrets.json, keys/, webhooks/) per source code - external-skills: fix config path to ~/.netclaw/config/netclaw.json - chat: fix broken /architecture/runtime/ links to /architecture/overview/ - pairing-remote-devices: fix health endpoint from /health to /api/health/ready - skills/overview + external-skills: fix cross-links from /architecture/security-model/ to /security/security-model/
No provider is the default — remove the OpenRouter-specific language and replace with neutral copy about supporting many providers.
- Write getting-started/installation (Linux, Windows, Docker, source) - Write getting-started/quickstart (init wizard walkthrough with screenshots) - Write getting-started/first-conversation (personality bootstrapping narrative) - Update channels/slack with copy-pasteable app manifest and setup screenshots - Update channels/discord with full 6-step bot creation walkthrough - Add 32 screenshots covering init flow, Slack/Discord setup, and chat sessions
- skill-server: Docker deployment, API key management, skillserver CLI, CI/CD integration pattern, API endpoint reference - skill-feeds: init wizard flow, manual config, sync behavior, skill authoring format, content scanning security, troubleshooting - Fix invocable field name in skills/overview to match AgentSkills.io spec
- Add observability/health-checks covering HTTP endpoints, Docker HEALTHCHECK, Kubernetes probes, and response format - Remove outbound notification webhooks from configuration/webhooks (belongs exclusively on operational-alerts page) - Fix secrets page: remove incorrect machine-bound claim, add note clarifying encryption prevents agent access not human access - Add prominent skill-server repo link
- Build site and run link-validator on PRs to dev - Fix broken MCP tool-use URL in first-conversation page
Matches the landing page's transparent-background icon.
- Add rehype-mermaid for build-time diagram rendering - Add sync flow diagram to skill-feeds page - Remove API key/auth references from skill-feeds (secured via VPN) - Fix secrets page: remove machine-bound claim, add agent-isolation note - Fix security-model: correct Personal audience attachment categories
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
.prose/write-doc-page.prose) to orchestrate the pipelinescripts/write-docs.shfor batch execution across 7 autonomous batches (38 pages)scripts/screenshot-page.mjsfor Playwright-based visual verification of rendered pagesdocs-queue.mdchecklist tracking all 45 pages across 8 batchesPages completed so far
observability/operational-alertscli/overviewcli/initcli/chatcli/sessions./scripts/write-docs.shTest plan
npm run buildpasses with all pages/humanizerpass on any pages that read too AI-generated