docs.tmlt.dev

This repo contains the content (and some scripting) for docs.tmlt.dev.

Documentation banners

The documentation committed to this repository does not have banners built into it, to avoid having to rebuild all of the old docs to change these banners. Rather, banners can be injected based on configuration files generated by the update-versions script. These banners are in turn managed by the package-banner-config.json file for each package. That file is organized as follows:

• The top-level key package_name gives the name of the package as it should be rendered in the banner.
• The top-level versions key maps individual version numbers to their configurations. These version-specific configurations currently only contain one option, supported, which if false causes a banner to be displayed encouraging users to upgrade to a newer version. Versions that do not appear in this config file are assumed to be current, and no banner is displayed for them.