Skip to content

Comments

Update README.md with correct links for Documentation section.#690

Merged
itopinsk merged 3 commits intodevelopfrom
itopinsk-patch-1
Jun 24, 2025
Merged

Update README.md with correct links for Documentation section.#690
itopinsk merged 3 commits intodevelopfrom
itopinsk-patch-1

Conversation

@itopinsk
Copy link
Contributor

@itopinsk itopinsk commented Jun 6, 2025

Correct links for Documentation section and added a link to oneMath Specification
README update only.

Correct links for Documentation section and added a link to oneMath Specification
@itopinsk itopinsk requested a review from a team as a code owner June 6, 2025 15:26
README.md Outdated
- [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)
Copy link
Contributor

Choose a reason for hiding this comment

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

"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#)

Copy link
Contributor

Choose a reason for hiding this comment

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

I've moved it

- 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)
Copy link
Contributor

Choose a reason for hiding this comment

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

"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.

Copy link
Contributor

Choose a reason for hiding this comment

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

Added the missed links, I'm not sure we need these page unless we have some information to add to these pages

@itopinsk itopinsk merged commit f125c00 into develop Jun 24, 2025
10 checks passed
@itopinsk itopinsk deleted the itopinsk-patch-1 branch June 24, 2025 13:46
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