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: revamp README #309

Merged
merged 5 commits into from
Oct 15, 2024
Merged

docs: revamp README #309

merged 5 commits into from
Oct 15, 2024

Conversation

masci
Copy link
Member

@masci masci commented Oct 11, 2024

Preview link

  • Link to llamaindex docs
  • Make it shorter
  • Add status badges

@coveralls
Copy link

coveralls commented Oct 11, 2024

Coverage Status

coverage: 65.828%. remained the same
when pulling 6473950 on massi/readme
into d53a748 on main.

@logan-markewich
Copy link
Collaborator

Do we still want some kind of quick-start in the readme? (Feels like something that most readme's have)

@masci
Copy link
Member Author

masci commented Oct 15, 2024

Do we still want some kind of quick-start in the readme? (Feels like something that most readme's have)

I was thinking the section "Getting started" would serve that purpose, any alternative you had in mind, or should I just move it upper?
Edit: I missed the still - I'm ok with removing it, the "getting started" might just be the list of examples, maybe with a stronger call to action

@logan-markewich
Copy link
Collaborator

Yea I like that idea -- just want to get users most quickly started from the readme 👍🏻

@logan-markewich logan-markewich merged commit e9fa21b into main Oct 15, 2024
10 checks passed
@logan-markewich logan-markewich deleted the massi/readme branch October 15, 2024 17:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants