Skip to content

docs: Update outdated documentation pages#28791

Open
Copilot wants to merge 4 commits into
gh-pagesfrom
copilot/update-documentation-outdated-pages
Open

docs: Update outdated documentation pages#28791
Copilot wants to merge 4 commits into
gh-pagesfrom
copilot/update-documentation-outdated-pages

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Jun 4, 2026

Description

Updates several stale pages on the ONNX Runtime documentation site (sourced from the gh-pages branch), addressing missing content, deprecated APIs, and outdated version information.

Changes by page:

  • docs/install/index.md — Adds WebGPU EP install instructions: how to use onnxruntime-web/webgpu import and the ort.webgpu.min.js script tag for browser usage.

  • docs/get-started/community-projects.md — Separates Rust from the Julia/Ruby community section; documents the ort crate as the Rust API for ONNX Runtime with a Cargo.toml snippet.

  • docs/get-started/training-pytorch.md — Removes the deprecated torch-ort / python -m torch_ort.configure flow; replaces with pip install onnxruntime-training and the correct onnxruntime.training.ortmodule.ORTModule import path.

  • docs/performance/model-optimizations/ort-format-models.md — Extends the backwards compatibility table to include 1.15+ (no breaking changes from 1.14).

  • docs/reference/operators/index.md — Fills in the previously empty operators index with descriptions of full vs. reduced builds, contrib ops, mobile ops, and links to custom operator guides.

  • docs/tutorials/accelerate-pytorch/pytorch.md — Fixes argument order in torch.onnx.export example: (model, PATH, example)(model, example, "model.onnx").

  • docs/get-started/with-python.md — Updates CUDA 11.8 header to CUDA 11.x; removes stale nightly feed entries from the Builds table.

  • docs/get-started/with-windows.md — Removes the outdated API contract version table (Windows OS 1809/1903/1909, ORT 1.2–1.4).

Motivation and Context

Several documentation pages listed in the issue were missing information (WebGPU install, Rust API), referencing deprecated packages (torch-ort), or showing obsolete version tables. These updates bring the affected pages in line with current ORT capabilities and recommended practices.

Copilot AI linked an issue Jun 4, 2026 that may be closed by this pull request
Copilot AI changed the title [WIP] Fix outdated documentation pages and add last updated timestamps docs: Update outdated documentation pages Jun 4, 2026
Copilot AI requested a review from justinchuby June 4, 2026 18:01
@justinchuby justinchuby changed the base branch from main to gh-pages June 4, 2026 18:06
@justinchuby
Copy link
Copy Markdown
Contributor

@copilot I think you need to rebase on the gh-pages branch

- install/index.md: Add WebGPU EP installation instructions for JavaScript/web
- get-started/community-projects.md: Clarify Rust API availability
- get-started/training-pytorch.md: Update outdated torch-ort installation (use onnxruntime-training directly)
- performance/model-optimizations/ort-format-models.md: Update backwards compatibility table (1.14+ -> 1.15+)
- reference/operators/index.md: Add meaningful content to empty operators index page
- tutorials/accelerate-pytorch/pytorch.md: Fix torch.onnx.export argument order in example
- get-started/with-python.md: Update CUDA 11.8 section and remove outdated nightly build links
- get-started/with-windows.md: Remove outdated DirectML API contract version table
Copilot AI force-pushed the copilot/update-documentation-outdated-pages branch from 504c196 to 4672583 Compare June 4, 2026 18:13
Copy link
Copy Markdown
Contributor Author

Copilot AI commented Jun 4, 2026

@copilot I think you need to rebase on the gh-pages branch

Done — rebased onto gh-pages in commit 46725837. The branch now has a single commit on top of 5afdf5efc (latest gh-pages).

Comment thread docs/get-started/community-projects.md Outdated
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@MaanavD I wonder if we should just remove this page?

Copilot AI requested a review from justinchuby June 4, 2026 21:29
Comment thread docs/tutorials/accelerate-pytorch/pytorch.md Outdated
@justinchuby justinchuby marked this pull request as ready for review June 4, 2026 21:33
Comment thread docs/get-started/community-projects.md Outdated
@justinchuby
Copy link
Copy Markdown
Contributor

@copilot is it possible to update the deployment script to show an last updated tag under the doc page titles? How hard would this be?

Copy link
Copy Markdown
Contributor Author

Copilot AI commented Jun 4, 2026

@copilot is it possible to update the deployment script to show an last updated tag under the doc page titles? How hard would this be?

It's definitely doable, but it would require a few coordinated changes and is probably a medium-effort task:

  1. Add the jekyll-last-modified-at gem to Gemfile — this plugin reads git log to automatically populate page.last_modified_at for each file without needing manual front matter on every page.

  2. Register it in _config.yml under plugins:.

  3. Override the just-the-docs layout by creating _layouts/default.html (copying it from the theme) and inserting something like:

    {% if page.last_modified_at %}
    <p class="text-small text-grey-dk-100">Last updated: {{ page.last_modified_at | date: "%B %-d, %Y" }}</p>
    {% endif %}

    right below the page <h1> title.

The main complication is that the layout override needs to stay in sync with upstream just-the-docs theme updates. If you'd like I can implement this in a follow-up PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Documentation] Outdated pages

2 participants