- When introducing links to other documentation pages, include the version, e.g.
/docs/hotchocolate/v12/some-page.
- Locate the directory of the product version you want to add a documentation entry for, e.g.
src/docs/hotchocolate/v12. - Create a new Markdown file in one of the appropriate categories (or create a new one).
- Open the
src/docs/docs.jsonfile and locate the array item where the value of thepathproperty matches the product. - Inside of the
versionarray, find the item where the value of thepathproperty matches the version. - Locate (or create) the correct category object in the
itemsproperty and add a new object to itsitemsproperty:
{
"path": "your_markdown_filename_without_the_extensions",
"title": "The title of your document"
},- Finish the Markdown file.
- Create a new directory for the new version inside of the product directory, e.g.
src/docs/hotchocolate/v13. - Copy the contents of the previous version directory into the newly created version.
- Open just the new version directory in a separate VS Code instance.
- Search for
/docs/hotchocolate/v12/and replace it with/docs/hotchocolate/v13/. (hotchocolatebeing the product,v12the previous version andv13the new version)
Note: Links in the
Migratingsection shouldn't be updated.
- Open the
src/docs/docs.jsonfile and locate the array item where the value of thepathproperty matches the product. - Inside of the
versionarray, copy and paste the object where the value of thepathproperty matches the previous version. - In the duplicated object, update both the
pathandtitleproperty to the new version. - Optionally adjust the default documentation version of the product.
- Open the
src/docs/docs.jsonfile and locate the array item where the value of thepathproperty matches the product. - Adjust the value of the
latestStableVersionproperty. - Open the
config/conf.d/default.conffile and adjust the value of the$latestvariable.