Quick start

In this tutorial, we will publish one documentation package to a Hosted Docs workspace and confirm it is live on the workspace subdomain. We will not connect Sources in this path.

What we will do

We will sign in, mint a push token, add a publish step that POSTs the built package, and open the branded subdomain.

Start here

Open https://hosted.devdocs.ai/login and sign in. You will notice the dashboard rail on the left. We need a workspace already provisioned (self-serve or through us) at your-subdomain.hosted.devdocs.ai.

Steps

1. Click Publishing credentials. Create a push token. It starts with hdpt_. The token is shown once. Copy it into a CI secret named HOSTED_DOCS_PUSH_TOKEN.
2. In the repo that already builds your docs, add this workflow on main:
   .github/workflows/publish.yml

   # .github/workflows/publish.yml
   name: Publish docs
   on:
     push:
       branches: [main]
   jobs:
     publish:
       runs-on: ubuntu-latest
       steps:
         - uses: actions/checkout@v4
         - uses: actions/setup-node@v4
           with:
             node-version: 24
         - run: npm ci
         - run: npm run docs:build
         - run: node scripts/publish.mjs
           env:
             HOSTED_DOCS_PUSH_TOKEN: ${{ secrets.HOSTED_DOCS_PUSH_TOKEN }}

3. Push to main. The output should look like a successful POST /api/broker/push with a new versionId.
4. Open https://your-subdomain.hosted.devdocs.ai. You will notice the new version as the live site.

What we accomplished

We published one immutable version from our own build. Sources sync is a different job and was not part of this path. *(see How-to: How to publish from your pipeline)* *(see How-to: How to connect a source)* *(see Explanation: About Hosted Docs)*