Skip to main content

Docs Site

docs.chukei.dev is the public documentation site for chukei. The site is a Docusaurus app in the osodevops/chukei-docs repository and is published by GitHub Pages from the Deploy Documentation workflow.

Last updated: 2026-06-15.

Repository

ItemValue
Docs repositoryosodevops/chukei-docs
Site sourcedocs/
Build commandcd docs && npm run build
Deploy workflow.github/workflows/docs-deploy.yml
Pages sourceGitHub Actions
Custom domaindocs.chukei.dev
Static domain filedocs/static/CNAME

The deploy workflow builds Docusaurus, generates llms.txt, llms-full.txt, and markdown.zip with osodevops/docusaurus-llm-docs, then deploys the generated docs/build artifact to GitHub Pages.

DNS

The chukei.dev zone is managed in 101domain. The required docs record is:

NameTypeValueTTL
docsCNAMEosodevops.github.io.default / 6 hours

Do not add apex A records for the docs site. The apex can be handled separately by a future marketing site; the docs host only needs the docs CNAME.

Verify authoritative DNS:

dig +short @ns1.101domain.com docs.chukei.dev CNAME
dig +short @ns2.101domain.com docs.chukei.dev CNAME
dig +short @ns5.101domain.com docs.chukei.dev CNAME

Expected output:

osodevops.github.io.

If public resolvers are slower than authoritative DNS, wait for propagation:

dig +short docs.chukei.dev CNAME
dig +short @1.1.1.1 docs.chukei.dev CNAME
dig +short @8.8.8.8 docs.chukei.dev CNAME

GitHub Pages

Set these values in osodevops/chukei-docs:

SettingValue
SourceGitHub Actions
Custom domaindocs.chukei.dev
Enforce HTTPSOn, after GitHub provisions the certificate

GitHub may show an SSL warning immediately after the DNS record is created. That usually means Pages is still serving the default *.github.io certificate and has not issued the custom-domain certificate yet. Wait and refresh the Pages settings page; when the certificate exists, enable Enforce HTTPS.

If certificate provisioning is still stuck after about an hour, remove and re-add docs.chukei.dev in the repository's Pages settings to trigger a new certificate request.

Verification

Check the latest deployment:

gh run list --repo osodevops/chukei-docs --workflow docs-deploy.yml --limit 3

Check Pages configuration:

gh api repos/osodevops/chukei-docs/pages \
--jq '{build_type:.build_type,cname:.cname,https_enforced:.https_enforced,html_url:.html_url}'

Check HTTP before HTTPS is enforced:

curl -I http://docs.chukei.dev/

Check HTTPS after GitHub has provisioned the certificate:

curl -I https://docs.chukei.dev/

Optional Domain Verification

GitHub organization-level Pages domain verification is optional for routing traffic, but useful for takeover protection. If enabled in the osodevops organization settings, GitHub will provide a TXT token. Add it in 101domain as:

NameTypeValue
_github-pages-challenge-osodevopsTXTtoken from GitHub

This TXT record does not replace the docs CNAME.