mirror of
https://github.com/paperclipai/docs.git
synced 2026-11-07 06:15:59 -10:00
Dotta
b3704410bd
* origin/main: docs: fix documentation drift — adapters, plugins, issue documents docs: fix logo, simplify quickstart, mention create-adapter skill # Conflicts: # docs.json # logo/dark.svg # logo/light.svg # start/quickstart.md
Paperclip Documentation
This repo now runs on Docusaurus and contains the public documentation site for Paperclip.
Commands
npm install
npm run start
npm run build
npm run typecheck
Run as a service
Use these commands when you want the docs site to run as a long-lived process:
# Development preview service
npm run start:service
# Production-style service
npm run service
Both service commands bind to 0.0.0.0 and default to port 3000. Set HOST or PORT to override them:
PORT=4300 npm run service
Use npm run build before npm run serve:service if you want to split the build and run steps across separate deploy phases.
Structure
start/,guides/,deploy/,adapters/,api/,cli/,specs/: documentation contentdocusaurus.config.ts: site configurationsidebars.ts: sidebar structuresrc/: theme overrides and custom UIstatic/: copied brand assets served by Docusaurus
Editing docs
Keep existing doc URLs stable when possible. Prefer editing the current markdown files in place instead of creating duplicate copies under a second content tree.