Skip to content

Serve the documentation from developers.timr.com - #1

Merged
daberni merged 1 commit into
mainfrom
api-1.0-specification-and-documentation
Aug 17, 2026
Merged

daberni merged 1 commit into
mainfrom
api-1.0-specification-and-documentation

Conversation

@daberni

@daberni daberni commented Aug 17, 2026 •

Copy link
Copy Markdown
Contributor

The documentation went live on the Pages default address, https://troii.github.io/timr-api/, because developers.timr.com still resolved through the *.timr.com wildcard to the production load balancer. That record is now a CNAME to troii.github.io, so the site can move to its own domain.

What changes

  • site/public/CNAME returns. Pages reads it on deployment and sets the custom domain from it, which is what makes the site answer on developers.timr.com.
  • site/vite.config.js goes away. It existed only to build the site for a subpath — without a base, every asset resolves to the domain root, which is correct again once the site is served from one.

Why this completes it

main already names the custom domain in the two places that have to agree with it: the try-it console's redirect URI in spec/overlay.yaml and the published-at address in README.md. Only the base URL and the CNAME were on the temporary address, so this is the last half of the pair. The console matters here specifically — the authorization server completes its flow only on a redirect URI registered exactly, so the address the site is served from and the URI the console sends have to be the same string.

After merging

pages.yml deploys and Pages picks up the custom domain from the CNAME file. developers.timr.com currently resolves but does not serve TLS, because Pages has no certificate for a domain it has not been told about yet; that resolves itself once the domain is set and verified.

Still needed before the try-it console works against the live API, both now pinned to https://developers.timr.com/ rather than the github.io address:

  • a public OAuth client with PKCE required and that exact redirect URI registered,
  • CORS on api.timr.com for that origin, with Authorization listed explicitly — a wildcard does not cover it.

Managing the Pages configuration itself as code is troii/github-management#90.

🤖 Generated with Claude Code

@daberni daberni mentioned this pull request Aug 17, 2026
@daberni
daberni force-pushed the api-1.0-specification-and-documentation branch from aa85a14 to d91bf7c Compare August 17, 2026 13:58
@daberni
daberni force-pushed the api-1.0-specification-and-documentation branch from d91bf7c to 285cd29 Compare August 17, 2026 14:00
@daberni daberni changed the title timr API 1.0 specification and documentation Serve the documentation from developers.timr.com Aug 17, 2026
@daberni
daberni merged commit 38aaaa3 into main Aug 17, 2026
1 check passed
@daberni
daberni deleted the api-1.0-specification-and-documentation branch August 17, 2026 18:23
daberni added a commit that referenced this pull request Sep 4, 2026
GitHub Pages serves the site at a custom domain declared in CNAME, so the Vite
base path goes.

Co-authored-by: Claude Opus 5 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

1 participant