Fix link to High Level Design #11786
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
faxu
reviewed
Feb 27, 2023
CONTRIBUTING.md
Outdated
| @@ -3,7 +3,8 @@ | |||
| We're always looking for your help to improve the product (bug fixes, new features, documentation, etc). | |||
|
|
|||
| ## Contribute a code change | |||
| * Start by reading the [Engineering Design](https://onnxruntime.ai/docs/reference/high-level-design). | |||
|
|
|||
| * Start by reading the [Engineering Design](https://onnxruntime.ai/docs/reference/high-level-design.html). More documentation can be found in the [docs folder](./docs/) and [on the docs website](https://onnxruntime.ai/docs). | |||
There was a problem hiding this comment.
Is there a distinction to call out between the docs hosted on github vs gh-pages? We also have documentation in the wiki: https://github.com/microsoft/onnxruntime/wiki (developer-oriented)
In general, I think the ones in github (both /docs and the wiki) are more relevant to developers of ORT, while the ones in gh-pages are for consumers of ORT. If that's accurate, it may be useful to call this out (and also ensure docs are located as described).
There was a problem hiding this comment.
Sure - clarified the wording - let me know what you think
faxu
approved these changes
Feb 27, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Address #11661