Skip to content

open-leash/docs-web

Repository files navigation

📚 Documentation that makes agent safety feel usable.


✨ What this app is

docs-web is the public documentation site for OpenLeash.

It explains how to install, run, self-host, integrate, and reason about OpenLeash across Individual Open Source, personal and organization OpenLeash Cloud, and Private Cloud.


🧭 What belongs here

  • Installation guides
  • Individual Open Source, OpenLeash Cloud, and Private Cloud explanations
  • API contracts
  • Plugin architecture, manifests, organization/user/agent settings resolution, Island contributions, capabilities, and examples
  • Agent hook support notes
  • Mobile setup
  • Identity provider setup
  • Architecture and open-source boundary docs
  • Migration and release workflow guidance
  • Community contribution docs

🛠 Run locally

npm install
npm run dev:docs-web

Open:

http://localhost:9306

✍️ Writing style

Prefer real commands:

npm run desktop-cli -- install-hooks --all

Then explain:

  • What happened
  • Which files or systems were touched
  • How to verify it worked
  • How to undo it safely

💛 Voice

Clear, practical, builder-friendly.

Security should feel understandable, not mystical.

Docs are part of the product. Make them feel like a good teammate.

About

OpenLeash documentation site.

Resources

License

Stars

0 stars

Watchers

0 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages