microsoft / microsoft/onnxruntime

[Documentation] Errors related to building for node

Open
#18,961 0 comments 0 reactions 0 assignees View on GitHub
documentation platform:web
Dominant language
C++
Stars
21.9k
Forks
4.2k
Avg merge
4d 11h
Merged PRs (30d)
184

Description

### Describe the documentation issue

I am trying to build a debug version of the js/web/node bindings.

The table for supported arch is wrong:

https://onnxruntime.ai/docs/build/inferencing.html#architectures

It shows that MacOS does not have amd64 which is wrong.

There is a coreML option for MacOS, so that should mean it supports the NPU and GPU, right?

https://onnxruntime.ai/docs/build/inferencing.html#build-environmentshost

The link from the codebase readme is wrong, see PR here https://github.com/microsoft/onnxruntime/pull/18960

The documentation is missing for custom saying how to build for web:
https://onnxruntime.ai/docs/build/custom.html#web

The non-custom part for web does not mention node:
https://onnxruntime.ai/docs/build/web.html

### Page / URL

https://onnxruntime.ai/docs/build/custom.html#web

Contributor guide

Open the contributing guide

Research direction

Start with the architecture and build-environment pages, then review the custom web and web build pages referenced in the issue, along with the codebase README and PR 18960. Verify the MacOS architecture and CoreML information, correct the README link, and document web builds for Node and custom builds. Done means the referenced pages accurately cover these cases.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, node.js
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.