feat: readme revamp #1108
Merged
feat: readme revamp #1108
Conversation
This file contains 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
sash-a
requested review from
arnupretorius,
DriesSmit,
RuanJohn,
jcformanek,
siddarthsingh1,
OmaymaMahjoub,
ulricharmel and
WiemKhlifi
as code owners
|
todo: add ruff badge |
|
todo: add shape legend in docs |
arnupretorius
requested changes
Dec 12, 2024
RuanJohn
requested review from
SimonDuToit and
Louay-Ben-nessir
as code owners
arnupretorius
requested changes
Dec 14, 2024
arnupretorius
approved these changes
Dec 18, 2024
RuanJohn
approved these changes
Dec 19, 2024
sash-a
added a commit
that referenced
this pull request
Jan 10, 2025
* feat: initial readme revamp * chore: some readme fixes * fix: convert images to png * chore: changes around performance plots in readme * chore: add more benchmark images * chore: update images * chore: rename legend * chore: add legend to readme * chore: move install + getting started near the top * feat: update system readmes * chore: a note on ISAC * chore: update branch naming convention doc * chore: some readme updates * feat: switch detailed install instruction to uv * docs: python badge * wip: system level docs * feat: readme badges * chore: add speed plot and move tables out of collapsible * fix: run pre commits * fix: tests budge link * feat: system level configs * chore: github math render fix * chore: github math render fix and linting * docs: add links to system readmes, papers and hydra * docs: qlearning paper links * docs: reword sebulba section to be distribution architectures * docs: change reference to sable paper * docs: clarify distribution architectures that are support for different envs * docs: general spelling mistake fixes and relative links to docs and files * docs: typo fixes * docs: replace absolute website links with relative links * docs: sable diagram caption * docs: sable caption math * docs: another sable diagram caption fix * docs: sable diagram math render * docs: add environment code and paper links --------- Co-authored-by: RuanJohn <[email protected]> Co-authored-by: OmaymaMahjoub <[email protected]> Co-authored-by: Ruan de Kock <[email protected]>
sash-a
added a commit
that referenced
this pull request
Jan 10, 2025
* feat: initial readme revamp * chore: some readme fixes * fix: convert images to png * chore: changes around performance plots in readme * chore: add more benchmark images * chore: update images * chore: rename legend * chore: add legend to readme * chore: move install + getting started near the top * feat: update system readmes * chore: a note on ISAC * chore: update branch naming convention doc * chore: some readme updates * feat: switch detailed install instruction to uv * docs: python badge * wip: system level docs * feat: readme badges * chore: add speed plot and move tables out of collapsible * fix: run pre commits * fix: tests budge link * feat: system level configs * chore: github math render fix * chore: github math render fix and linting * docs: add links to system readmes, papers and hydra * docs: qlearning paper links * docs: reword sebulba section to be distribution architectures * docs: change reference to sable paper * docs: clarify distribution architectures that are support for different envs * docs: general spelling mistake fixes and relative links to docs and files * docs: typo fixes * docs: replace absolute website links with relative links * docs: sable diagram caption * docs: sable caption math * docs: another sable diagram caption fix * docs: sable diagram math render * docs: add environment code and paper links --------- Co-authored-by: RuanJohn <[email protected]> Co-authored-by: OmaymaMahjoub <[email protected]> Co-authored-by: Ruan de Kock <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
What?
Updating the readme and moving the advanced usage to examples.
Why?
It is long overdue 😉
closes #1149