Skip to content
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

docs: update docs for release #129

Merged
merged 1 commit into from
Mar 22, 2024
Merged

docs: update docs for release #129

merged 1 commit into from
Mar 22, 2024

Conversation

jcharkow
Copy link
Collaborator

@jcharkow jcharkow commented Mar 22, 2024

update readme and docs

emphasize important details in readme. Move less important info to to docs

Contents (#129)

Other

  • update docs for release

update readme and docs

emphasize important details in readme. Move less important info to the
docs
@jcharkow jcharkow requested a review from singjc March 22, 2024 16:29
@jcharkow
Copy link
Collaborator Author

I've removed quite a bit of info from the readme. Moved to documentation so just wanted to check that is ok. I think it makes things cleaner

Copy link
Collaborator

@singjc singjc left a comment

Choose a reason for hiding this comment

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

Great looks good. We may need to add some github action in the future to automatically update the release version number in the hyperlinks, but for now we can just do it manually. We'll just need to keep track of all the places that use them.

@singjc singjc added documentation Improvements or additions to documentation enhancement New feature or request labels Mar 22, 2024
@singjc singjc merged commit 7e263d2 into dev Mar 22, 2024
11 checks passed
@singjc singjc deleted the patch/readme branch March 22, 2024 16:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants