Shareable previews let teammates review documentation changes on docs.page before they merge to your default branch. Push a branch or open a pull request, then open a URL with a ~ref segment. No local CLI required.
Public GitHub hosting serves production docs from your default branch. Branch preview adds a ref segment so docs.page fetches docs.json and page files from a specific branch, commit, or pull request instead.
Use shareable previews when you need feedback from others, want to compare a branch against production, or need search, sitemap, or agent features that local preview does not include.
Add ~{ref} immediately after the repository name:
https://docs.page/{owner}/{repo}~{ref}
https://docs.page/{owner}/{repo}~{ref}/{page-path}Examples:
| URL segment | Resolves to |
|---|---|
~feature-docs | Branch feature-docs |
~abc123… (40-character SHA) | That commit |
~42 | Pull request #42 head branch |
Production URLs omit the ~ref segment entirely. docs.page resolves numeric refs to pull request head branches through the GitHub API.
| Mode | When | How |
|---|---|---|
| Local preview | Fast iteration on your machine before push | docs preview |
| Branch preview | Share with reviewers after push | ~ref URL on docs.page |
| Production | Merged default branch | https://docs.page/{owner}/{repo} |
Run docs check after local preview looks right and before you push for shareable preview.
Install the GitHub App to post automatic pull request comments with live preview links. Each comment points at the ~ref URL for that PR's head branch so reviewers can open docs without constructing URLs manually.