We have several Astro sites that are essentially all static. They all work extremely similarly.

• Docs - modelmatch.com/docs
• Blog - modelmatch.com/blog
• Changelog - modelmatch.com/changelog
• Landing - modelmatch.com
  • Sub-routes take precedence over all routes for the web client, so this means that if a workspace has the name pricing, for example, it would be unreachable. This means that we need to make sure any landing page sub routes are off limits to workspace slugs; in addition to of course, docs and blog.

Changelog

The changelog needs to be written in mdx and all files titled with the version in kebab-case. Kebab case is important for git and our formatting.

/changelog/src
├── pages
│   ├── v-1-2-3.mdx
│   └── v-1-2-1.mdx
...

This means v1.2.3 and v1.2.1. You do not need to add canary or beta, because when the canary stage releases it will pick the most recent release and apply canary to it.

It is important to structure these files because there is a script that runs on release to update the version in the database.

Frontmatter

title: Release title
description: A short description that can be used as a subject for an email, or a quick note for an in-app-update.
image: The url for a heading image, for the in-app-update.

For image you can simply use /path/to/file if this is a local file, it will automatically add the stage's assets path.