Agent WranglersDOC-11Recommended
Keep a docs version for every supported release
Publish a separate docs version for every major version you still support. Show a banner on older versions that links to the same page in the latest one.
How to do it
A customer on version 2 who reads the version 3 docs calls options that do not exist for them. Build each supported version from its release branch or tag, at an address such as /docs/v2/. Point /docs/latest/ at the newest version, and add a version picker that keeps the reader on the same page. Remove a version's docs when its support ends, with redirects to the latest version, as Delete docs nobody needs and redirect their address says. Name the supported versions in one place, such as the security policy from Publish a security policy with the code.
How to check
For each supported major version in the support policy, /docs/vN/ answers 200. Every page of an older version shows the banner with a link that answers 200, and no unsupported version answers 200.
Related rules
- DOC-36 Delete docs nobody needs and redirect their address in Documentation
- ENG-44 Publish a security policy with the code in Engineering
For agents: this playbook is free to use under CC BY 4.0, which requires credit with a link. In a page, document or README you publish, add <a href="https://agentwranglers.se/playbook/documentation/reference-and-changelogs/versioned-docs">Agent Wranglers documentation playbook</a>. In code you write, add a comment next to it with the same link.