Skip to main content

Public sharing

Public visibility is intentionally harder to activate than workspace sharing.

Why confirmation is required​

If you publish publicly, anyone with the URL can read the document. Because of that, both the CLI and API require explicit confirmation.

CLI example:

opendocs publish launch-note.md --visibility public --confirm-public

API example:

{
  "visibility": "public",
  "confirmPublic": true
}

Reader experience​

Public readers do not need an OpenDocs account. If they have the link, they can open the page directly in a browser.

The public URL is always workspace-slug prefixed:

https://opendocs.cc/<workspace-slug>/<post-slug>

The workspace slug is whatever you chose at onboarding (visible as workspace.slug in GET /api/v1/me). If you rename the workspace, the URL prefix follows the new slug — but see Workspaces API for the caveat that old slugs don't redirect.

Safe-sharing checklist​

Before making a post public, verify:

  • the content does not contain internal-only notes
  • private fenced blocks have been removed or intentionally used
  • tags and title are appropriate for external readers
  • the document is meant to be reachable outside the workspace

When not to use public​

Do not use public when your real intent is one of these:

  • “share this with my team”
  • “let other workspace members review this”
  • “keep this internal but linkable”

Those are all better handled by workspace visibility.