feat: Restructure README #598
Merged
Conversation
This file contains hidden or 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
dushyantbehl
requested review from
aluu317,
anhuong,
fabianlim and
kmehant
as code owners
|
Thanks for making a pull request! 😃 |
praveenj83
requested changes
Aug 20, 2025
Contributor
praveenj83
left a comment
praveenj83
left a comment
There was a problem hiding this comment.
Multiple links are broken and the data processing section has not moved out. If any fix is more involved, I am ok to create a separate issue for it.
Signed-off-by: Dushyant Behl <[email protected]>
Signed-off-by: Dushyant Behl <[email protected]>
Co-authored-by: Praveen Jayachandran <[email protected]> Signed-off-by: Dushyant Behl <[email protected]>
dushyantbehl
force-pushed
the
restructure_readme
branch
2 times, most recently
from
45165d5 to
d04b5a2
Compare
Signed-off-by: Dushyant Behl <[email protected]>
dushyantbehl
force-pushed
the
restructure_readme
branch
from
d04b5a2 to
77a95b6
Compare
praveenj83
reviewed
Sep 4, 2025
Contributor
praveenj83
left a comment
praveenj83
left a comment
There was a problem hiding this comment.
Some fixes were missed
dushyantbehl
force-pushed
the
restructure_readme
branch
2 times, most recently
from
c4e364c to
ae511a0
Compare
Co-authored-by: Praveen Jayachandran <[email protected]> Signed-off-by: Dushyant Behl <[email protected]> Signed-off-by: Dushyant Behl <[email protected]>
dushyantbehl
force-pushed
the
restructure_readme
branch
from
ae511a0 to
793d04e
Compare
praveenj83
approved these changes
Sep 4, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Description of the change
Follwing the internal discussion we decided to restructure README into separate sections to make it smaller. This PR converts the README into three different pages making the main README smaller and more readable.
Was the PR tested
NA