Add instructions for previewing docs changes (#12528)

This commit is contained in:
Nat Kershaw (MSFT) 2023-02-09 16:25:46 -08:00 committed by GitHub
parent 94bc0fe029
commit 9a9d45fefb
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -54,6 +54,8 @@ The html docs are generated from markdown using Jekyll and published using GitHu
To update the docs, create a Pull Request against the [gh-pages](https://github.com/microsoft/onnxruntime/tree/gh-pages) branch of the [ONNX Runtime repo](https://github.com/microsoft/onnxruntime).
To preview your changes, you can push to the gh-pages branch in your fork and this will publish a staged version of your changes to <github user name>.github.io/onnxruntime/docs.
Once your PR is approved and merged, your changes will be automatically published to https://onnxruntime.ai/docs.
Note: technical reference docs for developers of ONNX Runtime source code can be found [here](https://github.com/microsoft/onnxruntime/docs)