Skip to main content

Publishing & Updates

When your documentation is ready, publish it to a live URL with a single click. Subsequent publishes update the same site.

Your Published URL​

Every published site gets a Docsio subdomain:

yourproject.docs.docsio.co

The subdomain is based on your project slug, which is set when you create the project.

First Publish​

The first time you publish, Docsio creates a new hosted site for your project. This includes:

  • Building your Markdown content into a static site
  • Deploying the site to a global CDN
  • Provisioning SSL for HTTPS
  • Generating a search index for your content
info

DNS and SSL provisioning may take a few minutes on the first deployment. After the initial setup, subsequent publishes are faster.

Publishing Updates​

Every publish after the first updates the same site at the same URL. The process is the same:

  1. Click Publish in the editor
  2. Wait for the build to complete
  3. Your updated site is live

What Happens During a Build​

When you publish, the following steps run automatically:

  1. Compile -- Your documentation pages, configuration, and custom CSS are compiled into a static site
  2. Deploy -- The built site is deployed to hosting with a global CDN
  3. Index -- The search index is regenerated so your site search reflects the latest content

A typical build takes 30 to 90 seconds depending on the size of your documentation.

Build Status​

After clicking Publish, you see a status indicator:

  • Building -- The build is in progress
  • Completed -- The build succeeded and your site is live
  • Failed -- Something went wrong during the build

Handling Build Failures​

If a build fails, an error message is displayed explaining what went wrong. Common causes include malformed Markdown or invalid configuration.

To recover from a failed build:

  1. Read the error message to identify the issue
  2. Ask the AI agent to fix the problem (e.g., "Fix the Markdown syntax error on the installation page")
  3. Click Publish again
tip

If you are unsure what caused a failure, ask the agent: "The last build failed. Can you check for any issues in the project?"

Every publish regenerates the search index for your site. Your published documentation includes built-in search accessible via the Cmd+K (Mac) or Ctrl+K (Windows/Linux) keyboard shortcut. Search covers page titles and headings across your entire site.