Skip to content

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.

Making a Change

  1. Make a fork from microsoft/onnxruntime.
  2. Checkout gh-pages. Create a branch off of gh-pages to make your edits.

Change

  1. Add Navigation instructions. Example
---
nav_exclude: true
---
OR
---
title: Title
parent: Parent Title
grand_parent: Reference
nav_order: 3
---
  1. Make sure all links to documents in docs folder are relative so they properly pickup Jeykll formatting
  2. Add {: .no_toc} for no table of contents

Preview Change

  1. Navigate to your fork on github.com. Click on Settings > Pages.
  2. 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…"

Create a PR

  1. After validating changes, create a PR into gh-pages including a link to your hosted Github page for easier validation.
  2. Only authorized users can approve and merge.