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

Vamp up the README #446

Merged
merged 10 commits into from
Jan 9, 2025
Merged

Vamp up the README #446

merged 10 commits into from
Jan 9, 2025

Conversation

frankiebee
Copy link
Contributor

@frankiebee frankiebee commented Jan 7, 2025

closes #443
The purpose of this PR is to "kick off" better docs and to get one step closer to getting our docs up on the docs website:

What the README has now:

  • Quick overview (what this SDK is for, who it's for, some example use-cases)
  • Installation instructions
  • Basic usage example (bonus: runnable code)
  • Links to detailed docs over at docs.entropy.xyz (@johnnymatthews this one is on you)

BONUS:

  • test for the code example (if this ever fails the readme needs to be updated!)

@frankiebee frankiebee changed the title remove doc bloating from README Vamp up the README Jan 7, 2025
@frankiebee
Copy link
Contributor Author

frankiebee commented Jan 7, 2025

🔥 HEADS UP: you'll see i've added a test here: tests/README.test.ts 😈 it parses the README for the code example. this does mean the read me is now a sensitive place however it also means that if you change the api surface and dont update the read me to match the executable it will fail the tests! 🔥

@frankiebee frankiebee added this to the better docs milestone Jan 7, 2025
@johnnymatthews
Copy link
Contributor

@frankiebee are you done with this PR? If so, I'd like to run through it before it gets merged. Don't wanna step on your toes if you're still working on it though.

@frankiebee
Copy link
Contributor Author

frankiebee commented Jan 8, 2025

@frankiebee are you done with this PR? If so, I'd like to run through it before it gets merged. Don't wanna step on your toes if you're still working on it though.

i'm done writing doc words so please take a look! i would like you too
dont worry about stepping on my feet they are very strong

@frankiebee frankiebee marked this pull request as ready for review January 8, 2025 22:03
@frankiebee frankiebee merged commit ba9290d into main Jan 9, 2025
3 checks passed
@frankiebee frankiebee deleted the frankie/i#443-readme-update branch January 9, 2025 02:14
@github-actions github-actions bot locked and limited conversation to collaborators Jan 9, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Improve the readability and this repo's README
2 participants