-
Notifications
You must be signed in to change notification settings - Fork 2.9k
Update ONNX Runtime Docs
Faith Xu edited this page Jun 2, 2021
·
4 revisions
ONNX Runtime documentation is hosted on https://www.onnxruntime.ai/docs/ using Github Pages. To update the documentation, send a PR to the gh-pages branch. Approval from an ONNX Runtime repo maintainer or admin is required for merging.
Please follow the guidance below for updates to the Docs pages.
- Make a fork from microsoft/onnxruntime.
- Checkout gh-pages. Create a branch off of gh-pages to make your edits.
- Add Navigation instructions. Example
---
nav_exclude: true
---
OR
---
title: Title
parent: Parent Title
grand_parent: Reference
nav_order: 3
---
- Make sure all links to documents in docs folder are relative so they properly pickup Jeykll formatting
- Add {: .no_toc} for no table of contents
- Navigate to your fork on github.com. Click on Settings > Pages.
- Select the Source to track the branch you created, select /docs as the folder. View your changes at the URL listed at "Your site is ready…"
- After validating changes, create a PR into gh-pages including a link to your hosted Github page for easier validation.
- Only authorized users can approve and merge.
Please use the learning roadmap on the home wiki page for building general understanding of ORT.