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.

Sign up for GitHub

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

Jump to bottom

docs: rewrite the README #8436

Closed
1 task done
lostmygithubaccount opened this issue Feb 23, 2024 · 0 comments · Fixed by #8524
Closed
1 task done

docs: rewrite the README #8436

lostmygithubaccount opened this issue Feb 23, 2024 · 0 comments · Fixed by #8524
Assignees
@lostmygithubaccount
Labels
docs Documentation related issues or PRs

Comments

@lostmygithubaccount
Copy link
Member

Please describe the issue

documentation can always be improved

while doing #8251, it would be good to update the README. also some recent VoDa internal feedback

opening this for tracking + any community input

  • clear and concise explanation of Ibis
  • at least one diagram/picture
  • notes on use cases and who it's for
  • example code

Code of Conduct

  • I agree to follow this project's Code of Conduct
@lostmygithubaccount lostmygithubaccount added the docs Documentation related issues or PRs label Feb 23, 2024
@lostmygithubaccount lostmygithubaccount self-assigned this Feb 23, 2024
@lostmygithubaccount lostmygithubaccount moved this from backlog to todo in Ibis planning and roadmap Feb 23, 2024
@lostmygithubaccount lostmygithubaccount mentioned this issue Mar 2, 2024
Merged
@lostmygithubaccount lostmygithubaccount moved this from todo to review in Ibis planning and roadmap Mar 2, 2024
lostmygithubaccount added a commit that referenced this issue Mar 4, 2024
@lostmygithubaccount
docs: rewrite readme (#8524)
9a741f7 
## Description of changes

opening for discussion/feedback. this:

- makes the README cleaner
- quickly gets to bullet points for "Why", then links out to docs for
further reading
- quickly gets to code example
- other edits

we should also IMO update the GitHub description to "the portable Python
dataframe library" -- the "flexibility of Python with the scale and
performance of modern SQL" is in the REAMDE now

feedback welcome

## Issues closed

closes #8436 

cc: @chiphuyen @zhenzhongxu @ianmcook for feedback (in addition to the
Ibis team who will see this PR anyway)
@github-project-automation github-project-automation bot moved this from review to done in Ibis planning and roadmap Mar 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@lostmygithubaccount lostmygithubaccount

Labels
docs Documentation related issues or PRs
Projects
Ibis planning and roadmap
Archived in project
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs: rewrite readme
1 participant
@lostmygithubaccount