Dokki Docs logo

Public Sites

A public site turns selected Dokki resources into a browsable website. Use it for product documentation, public guides, knowledge bases, reports, and other approved information.

Create the site

  • Open Workspace → Extensions → Publish.

  • Choose a site address and turn the site on.

  • Publish the resources visitors should be able to open.

  • Open the public address in a signed-out window and review the site.

Organize the visitor experience

Use Appearance to choose the home-page behavior and add tag-based navigation. Use Content to control which resources are available. Use Site settings for the address, listing, languages, and custom domain.

Listed and unlisted sites

  • A listed site can appear in supported discovery surfaces such as the site's sitemap.

  • An unlisted site can still be opened by someone who has its direct link, but it is excluded from normal discovery and search indexing signals.

Use workspace or resource sharing—not an unlisted public site—when access must be limited to named people.

Keep the site current

When a published resource changes, its status becomes Updated. Review the change and commit a new public version. If the status is Unknown, retry before publishing so you do not act on incomplete information.

Languages and domains

Site settings can offer additional public languages and connect a custom domain. Configure the default site first, then add these options and verify them from the visitor's point of view.

Mirror published Markdown to GitHub

In Site settings → GitHub sync, connect GitHub, choose a repository, branch, and optional base path, then save before selecting Sync now. Workspace Editors and Admins can run the sync when the workspace's plan permits Sites. Automatic sync can also be enabled for later published updates.

Dokki generates a README.md index and one Markdown file for each currently published resource. The files follow the published resource tree and include canonical source metadata plus generated_by: Dokki. A sync updates changed generated files, leaves identical files alone, and removes stale Markdown only when it carries that generation marker; unrelated repository files are not part of cleanup.

The GitHub repository is a mirror of frozen published content, not the editing source. Edit and publish in Dokki, then sync again. Direct edits to generated Markdown can be overwritten by a later sync.

Before sharing the site

  • Check every navigation item and important link.

  • Review the site on desktop and a narrow screen.

  • Confirm that no private names, comments, credentials, or draft content are included.

  • Check the public page again after every important update.

Public Sites | Dokki Docs