Update README.md with correct links for Documentation section. #690
Conversation
Correct links for Documentation section and added a link to oneMath Specification
README.md
Outdated
| - Get Started | ||
| - [Selecting a Compiler](https://uxlfoundation.github.io/oneMath/selecting_a_compiler.html) | ||
| - [Building the Project with DPC++](https://uxlfoundation.github.io/oneMath/building_the_project_with_dpcpp.html) | ||
| - [Building the Project with AdaptiveCpp](https://uxlfoundation.github.io/oneMath/building_the_project_with_adaptivecpp.html) | ||
| - Developer Reference | ||
| - [oneMath Defined Datatypes](https://uxlfoundation.github.io/oneMath/onemath-datatypes.html) | ||
| - [Dense Linear Algebra](https://uxlfoundation.github.io/oneMath/domains/dense_linear_algebra.html) | ||
| - [Sparse Linear Algebra](https://uxlfoundation.github.io/oneMath/domains/sparse_linear_algebra.html) | ||
| - [Integrating a Third-Party Library](https://uxlfoundation.github.io/oneMath/create_new_backend.html) |
There was a problem hiding this comment.
"Integrating a Third-Party Library" is a sub-bullet to "Developer Reference" according to the documentation (https://uxlfoundation.github.io/oneMath/create_new_backend.html#)
| @@ -602,15 +602,13 @@ Product | Supported Version | License | |||
| --- | |||
|
|
|||
| ## Documentation | |||
| - [Contents](https://uxlfoundation.github.io/oneMath/) | |||
| - [About](https://uxlfoundation.github.io/oneMath/introduction.html) | |||
| - [oneMath Specification](https://oneapi-spec.uxlfoundation.org/specifications/oneapi/latest/elements/onemath/source/) | |||
| - Get Started | |||
| - [Selecting a Compiler](https://uxlfoundation.github.io/oneMath/selecting_a_compiler.html) | |||
| - [Building the Project with DPC++](https://uxlfoundation.github.io/oneMath/building_the_project_with_dpcpp.html) | |||
| - [Building the Project with AdaptiveCpp](https://uxlfoundation.github.io/oneMath/building_the_project_with_adaptivecpp.html) | |||
There was a problem hiding this comment.
"Get started" section in the documentation has more sub-sections:
Could you please align content of README with documenation?
Another option could be to pass links to "Get started" and "Developer Reference" itself without links to sub-sections, but there are no pages named "Get started" and "Developer Reference". So, the next step can be to create such pages for oneMath documentation.
There was a problem hiding this comment.
Added the missed links, I'm not sure we need these page unless we have some information to add to these pages
Correct links for Documentation section and added a link to oneMath Specification
README update only.