diff --git a/README.md b/README.md index 3e05faa..2e5a857 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,8 @@ intended capabilities, while implementation notes describe current behavior. The [Papyrus GitHub Project](https://github.com/orgs/PapyrusReader/projects/1) tracks requirements and tasks across the component repositories. +Published documentation: . + ## Setup and preview Install uv, Python 3.12, and Graphviz (`dot` must be on PATH), then run: @@ -23,6 +25,27 @@ back into `development`. The Deploy workflow builds with the same lock and publishes GitHub Pages only from `master`, including manual runs. Keep both long-lived branches and do not squash release promotions. +## Hosting and custom domain + +GitHub Pages hosts the documentation independently of the application server. +In this repository's **Settings → Pages**, use **GitHub Actions** as the build +source and set the custom domain to `docs.papyrus-reader.com`. +The DNS record is: + +| Type | Name | Target | +| --- | --- | --- | +| CNAME | `docs` | `papyrusreader.github.io` | + +Use DNS-only routing while GitHub validates the domain and issues its TLS +certificate, then enable **Enforce HTTPS** in Pages settings. The CNAME target +must not include `/docs` or a URL scheme. Actions deployments use the custom +domain from Pages settings, not a repository `CNAME` file. `html_baseurl` in +`conf.py` sets canonical page URLs to the same HTTPS domain. + +After a production deployment, check the homepage, a nested manual page, and +their styles and navigation at the custom domain. DNS and certificate issuance +must finish before HTTPS can be verified. + ## Requirements and local agents Run `make requirements` to validate and export the structured requirements and diff --git a/conf.py b/conf.py index 333c7bc..f0af331 100644 --- a/conf.py +++ b/conf.py @@ -9,6 +9,7 @@ html_css_files = ["custom.css"] html_js_files = ["mermaid-panzoom.js"] html_title = "Papyrus" +html_baseurl = "https://docs.papyrus-reader.com/" html_theme_options = { "light_css_variables": {