Skip to content

Update ONNX Runtime Docs

Faith Xu edited this page Jun 8, 2021 · 4 revisions

Update ORT documentation

Depending on topic/audience, there are a few places that ORT documentation should live.

  1. Customer-facing: All ORT user facing documentation should be on https://www.onnxruntime.ai/docs, which is hosted through Github Pages (gh-pages branch. We use the Just the Docs Jekyll theme to generate the layout for these pages. See instructions below for how to update this.

  2. Developer-facing: All documentation and resources helpful for developers of ONNX Runtime should live in this wiki.

  3. Other: In some cases, the most appropriate place to document something may be in the code itself, or a file residing right next to some code files. This may also be useful if the documentation needs to correspond to a specific version of ORT. In general, since Github is not the easiest place to search for documentation files, try to refrain from putting important documentation here if it can be better represented in #1 or #2 above.


onnxruntime.ai/docs

To update the documentation on onnxruntime.ai/docs, send a PR to the gh-pages branch. Approval from an ONNX Runtime repo maintainer or admin is required for merging.

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. In most cases using /(root) folder will work. Save your changes and it'll generate within a couple minutes.
  3. You'll receive an email when the page is built and you can view your changes at the URL listed at "Your site is ready…". In some cases you may need to clear your browser cache or open an in-private tab.

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.