Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[doc] Update "Get Started" page for ORT web #19568

Merged
merged 3 commits into from
Feb 23, 2024

Conversation

fs-eire
Copy link
Contributor

@fs-eire fs-eire commented Feb 19, 2024

Description

This PR re-arranges documentation of ORT web.

Current doc: https://onnxruntime.ai/docs/
Change preview: https://fs-eire.github.io/onnxruntime/docs/

  • split Doc -> Get Started -> JavaScript from single page into multiple pages, to make it easier to split from web, node and react-native
  • remove Doc -> Get Started -> with Web. The page was a few links and now they are moved to other places
  • add a few contents into Doc -> Get Started -> JavaScript -> Web. Now this is the main page for ORT web doc.
  • rename Tutorials -> deploy on Web to Tutorials -> Web. "deploy" is confusing as it's not the accurate term to describe the content.

=================================================================

ORT web documentation work item list:

  • Update Get Started page for ORT web at onnxruntime.ai ( this PR )
    • to make it easier for users to navigate
  • Update Tutorials page for ORT web at onnxruntime.ai
    • The purpose of this page is unclear. It contains descriptive information and step-by-step instructions on an E2E examples. It can be a good Blog, but not good for documentation, which usually has a well-structured content.
    • The index page has duplicated contents with its child page "Build a web application with ONNX Runtime"
    • Some contents are out-of-dated.
  • Update API Usage - SessionOptions on onnxruntime-inference-examples repo.
    • Add explaination and examples if necessary for all new WebGPU session options.
  • Update API usage - ort.env flags on onnxruntime-inference-examples repo.
    • Add all newly introduced flags.

@fs-eire fs-eire force-pushed the fs-eire/gh-pages branch 2 times, most recently from fa00074 to 19d503d Compare February 20, 2024 19:52
Copy link
Contributor

@guschmue guschmue left a comment

Choose a reason for hiding this comment

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

fine with this one. I think we can/should add a section for webgpu - explaining things like io-bindings, ...

@fs-eire fs-eire merged commit cfdb434 into microsoft:gh-pages Feb 23, 2024
7 checks passed
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.

3 participants