About Versioning

Note: This content is not actively maintained. If you'd like us to maintain these guides, let us know by opening an issue.

We provide versioned documentation to give you the correct information, guides, and tutorials for each supported and released version of Multiplayer Networking packages. Our documentation tool Docusaurus provides fantastic support for multiple products with multiple versions.

You will need to know some of this information when contributing to the doc site. But we promise, it's easy!

Versioned Content

Currently, the site has content following the versioning for Unity MLAPI and Boss Room. We will provide further versioning support as we release new versions. All versioned content is in folders, not tracked by branches.

Markdown	Side Nav	Description
/docs	sidebars.js	This content is for the NEXT release! It matches features and changes for the develop branch for MLAPI, etc. When a new release is ready, we cut a new version from this folder and sidebars file. For example, when MLAPI 1.0.0 is ready to release, we will create that version from these files with a single command.
/versioned_docs	/versioned_sidebars	These folders contain the previous versioned content. When we create a version from /docs, it adds all markdown files and side nav to the folders using that new version. For example, MLAPI 0.1.0 content is in these two folders names version-0.1.0. You updated these files to modify content for v0.1.0.

Non-Versioned Content

Some content on the site does not require a version. You can modify this content in specific folders and side nav files. See the following to find, edit, and add to that content:

Markdown	Side Nav	Description
/releases	sidebarsReleases.js	Release notes and changelogs. This gives users a way to see all release notes for all products. They can then select links in those release notes to that versioned content.
/reference	sidebarsReference.js	Documentation templates, licenses, and a version matrix. We plan to add additional reference content in this folder over time.