Skip to content

Latest commit

 

History

History
 
 

documentation

Cutting docs for a new version

use ./cut-docs.sh to automate steps 1-4

  1. Add the version to versions.json
    1. Note: The versions are shown in the listed order, with the first element being default version.
  2. Create the directory ./versioned_docs/version-<RELEASED_VERSION>
  3. Copy the contents of ./docs/ to the folder
  4. Copy ./sidebars.js to ./verioned_sidebars/version-<RELEASED_VERSION>-sidebars.json and remove module.exports = from the start of the file
  5. Push/merge to master to update kotest.io
  6. A crawl of newly added docs will be trigger by github action
    • To manually initiate crawl go to crawler.algolia.com
    • search will be broken until this is triggered

Updating docs

Make sure to update the versioned docs if you intend to update docs for the current stable version. /docs is for the current snapshot version.