Skip to content

Serve the docs from docs.tmlt.dev #13

@Maegereg

Description

@Maegereg

Traditionally, tmlt.dev was a landing page with marketing material about the tumult platform, and docs.tmlt.dev was the actual docs. We tried to set up the new docs site to serve from tmlt.dev, with docs.tmlt.dev redirected to tmlt.dev.

The redirect is not working because as far as I can tell, github pages doesn't support serving the same content on multiple subdomains. We could create different repositories to serve to tmlt.dev and docs.tmlt.dev, but a single repository can only serve one of the two (and right now we're picking tmlt.dev).

I propose that we switch to serving the docs from docs.tmlt.dev. This will ensure that old links to the docs (such as the ones in the Core documentation) continue to work - right now they're broken. I also propose that we set up a separate github project to serve content at tmlt.dev - initially this can be a javascript redirect to docs.tmlt.dev, but we can add a new landing page later if we want.

Alternatives considered:

Instead of setting up a new repository for tmlt.dev, we could try to use redirects from our domain hosting provider to do so. However, it's unclear whether our domain provider supports this, and it's more complicated/less accessible than making a new pages site (given that few of us have access to the domain hosting settings). It probably would provide a better use experience (javascript redirects are comparatively slow), but that doesn't seem to outweigh the benefits of the current approach.

We could also keep serving the docs from tmlt.dev and redirect the other way, but that's inconsistent with past links.

We could also create two repositories with mirrored content and serve identical things at both. However, this would encourage folks to save new links like https://tmlt.dev/analytics/latest/index.html, which would make it difficult to serve a landing page at tmlt.dev in the future.

We could also ditch docs.tmlt.dev completely, and serve everything off of tmlt.dev. If we ever want to make this switch the best time to do so is now (really, the best time to do so was 2 years ago, but the second best is now). However, there are enough accumulated links to docs.tmlt.dev (both in our documentation, and in external sites, e.g. https://www.reddit.com/r/privacy/comments/zfyiul/comment/ize4jrg/?utm_source=share&utm_medium=web3x&utm_name=web3xcss&utm_term=1&utm_content=share_button) that this seems unwise.

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions