README.md

DocStart (Implementation + Usage Docs)

This folder is the practical documentation track for:

  • developers implementing/linking clients
  • operators deploying via Portainer
  • users integrating a server quickly

Read This First

  1. getting-started/access-modes.md
  2. getting-started/portainer-stack.md
  3. getting-started/linking-and-auth.md
  4. getting-started/troubleshooting.md
  5. reference/setup-response.md

Sections

Getting Started

  • getting-started/access-modes.md
  • getting-started/portainer-stack.md
  • getting-started/linking-and-auth.md
  • getting-started/local-build.md
  • getting-started/troubleshooting.md

Reference

  • reference/docker-compose.md
  • reference/setup-response.md
  • reference/link-handler-spec.md
  • reference/relay.md
  • reference/relay-docker-compose.md

Frontend Integration Notes

  • frontend.md

About /docs

/docs remains the blueprint/planning track (architecture and long-term product plan). /docstart is the implementation/use track.

On the web client, test.mino.ink/docs now exposes both tracks in one browser entrypoint.