microsoft / microsoft/FLAML

Versioning in documentation

Open
#808 0 comments 0 reactions 1 assignee Claimed by @liususan091219 View on GitHub
documentation enhancement
Dominant language
Jupyter Notebook
Stars
4.4k
Forks
565
Avg merge
5d 8m
Merged PRs (30d)
17

Description

Steps:
1. Follow the guide [here](https://microsoft.github.io/FLAML/docs/Contribute#documentation) to build the documentation website locally. After this step, one should see a `reference` folder created under `website/docs/`.
1. Follow https://docusaurus.io/docs/versioning to create a versioned doc. Check https://docusaurus.io/docs/docs-multi-instance to separate the parts that need to be versioned and the parts that don't.
1. Test the change locally to verify it works as expected.
1. Make a PR to check in the versioned doc.

The above steps should be repeated every time before a major new release which modifies user-facing APIs.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.