Skip to content

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

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.

Sign up for GitHub

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

Merged
merged 3 commits into from
Jun 24, 2025
Merged

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

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d58033c
Update README.md with correct links for Documentation section.
itopinsk Jun 6, 2025
1e124af
Update README.md
mkrainiuk Jun 18, 2025
57a2c4a
Update README.md
mkrainiuk Jun 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -602,16 +602,16 @@ 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)
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

- [Building and Running Tests](https://uxlfoundation.github.io/oneMath/building_and_running_tests.html)
- [Using oneMath in your project with CMake](https://uxlfoundation.github.io/oneMath/using_onemath_with_cmake.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)
- [Integrating a Third-Party Library](https://uxlfoundation.github.io/oneMath/create_new_backend.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)

---

Expand Down
Loading