use ./cut-docs.sh
to automate steps 1-4
- Add the version to versions.json
- Note: The versions are shown in the listed order, with the first element being default version.
- Create the directory
./versioned_docs/version-<RELEASED_VERSION>
- Copy the contents of
./docs/
to the folder - Copy
./sidebars.js
to./verioned_sidebars/version-<RELEASED_VERSION>-sidebars.json
and removemodule.exports =
from the start of the file - Push/merge to master to update kotest.io
- 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
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.