Skip to content

Edited the readme and reorganized the toc #69

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.

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

Conversation

spolifroni-amd
Copy link
Contributor

No description provided.

@spolifroni-amd spolifroni-amd added documentation Improvements or additions to documentation ci:docs-only labels Oct 31, 2024
@AryanSalmanpour AryanSalmanpour force-pushed the spolifroni-amd/edit-readme branch from 586c38d to f8ceadc Compare November 7, 2024 22:25
@AryanSalmanpour AryanSalmanpour force-pushed the spolifroni-amd/edit-readme branch from fdcf99b to b3d7144 Compare November 8, 2024 12:05
@AryanSalmanpour AryanSalmanpour merged commit b2973fe into ROCm:develop Nov 8, 2024
1 check passed
spolifroni-amd added a commit to spolifroni-amd/rocJPEG that referenced this pull request Dec 5, 2024
* Edited the readme so that it doesn't duplicate information in the official online docs

* rearranged the toc to match the new structure

* moved Docker section
spolifroni-amd added a commit that referenced this pull request Dec 5, 2024
* Prepare documentation (#57)

* Updated the readme file to point to the official documentation

* first commit of new documentation structure

* split up and reconfigured Using rocJpeg

* Updated the readme file to point to the official documentation

* first commit of new documentation structure

* split up and reconfigured Using rocJpeg

* fixed missing space

* All changes asked for in the PR except the Destroy Handles part.

* separated creating and destroying handles; added a destroying handles section; added links to hipmalloc() and hipfree()

* removed the installation and build sections so that it doesn't conflict/go out of sync with the official doc

* putting readme back the way it was, minus documentation section

* changed some wording around hipFree()

* Fix a typo in README/Docs (#66)

* Edited the readme and reorganized the toc (#69)

* Edited the readme so that it doesn't duplicate information in the official online docs

* rearranged the toc to match the new structure

* moved Docker section

---------

Co-authored-by: Aryan Salmanpour <[email protected]>
kiritigowda pushed a commit that referenced this pull request Dec 10, 2024
* Update documentation requirements

* Upd doc reqs

* Update RTD yaml

* cherry pick to add documentation (#94)

* Prepare documentation (#57)

* Updated the readme file to point to the official documentation

* first commit of new documentation structure

* split up and reconfigured Using rocJpeg

* Updated the readme file to point to the official documentation

* first commit of new documentation structure

* split up and reconfigured Using rocJpeg

* fixed missing space

* All changes asked for in the PR except the Destroy Handles part.

* separated creating and destroying handles; added a destroying handles section; added links to hipmalloc() and hipfree()

* removed the installation and build sections so that it doesn't conflict/go out of sync with the official doc

* putting readme back the way it was, minus documentation section

* changed some wording around hipFree()

* Fix a typo in README/Docs (#66)

* Edited the readme and reorganized the toc (#69)

* Edited the readme so that it doesn't duplicate information in the official online docs

* rearranged the toc to match the new structure

* moved Docker section

---------

Co-authored-by: Aryan Salmanpour <[email protected]>

* Update README.md

---------

Co-authored-by: alexxu-amd <[email protected]>
Co-authored-by: Sam Wu <[email protected]>
Co-authored-by: Aryan Salmanpour <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ci:docs-only documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants