-
Notifications
You must be signed in to change notification settings - Fork 16
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
Improve setup docs and add CLI docs #44
Conversation
navarone-feekery
commented
Jun 7, 2024
- Add version compatibility
- Add tech-preview status
- Clean up Setup section
- Add CLI.md
- Move crawl instructions to CLI.md
@danajuratoni I will add a feature comparison table in a different PR |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looking good, just a few initial suggestions about moving stuff around, clarifying a few things, and keeping the user workflow front and centre.
Co-authored-by: Liam Thompson <32779855+leemthompo@users.noreply.github.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Few final pedantic suggestions, thanks for bearing with me. No rush here obviously, but I've got my editing hat on this afternoon so I've been following up. :)
@leemthompo thanks for all the feedback, it's really valuable. I think everything is addressed now. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM. Thanks for iterating, thi now feels a great resource for getting started and understanding how the crawler works. 🎉
We'll work on more e2e examples when we start planning the full docs experience.
I'll defer to the team for any additional context or technical input that won't be on my radar for the repo docs right now.
Co-authored-by: Liam Thompson <32779855+leemthompo@users.noreply.github.com>
- Add version compatibility - Add tech-preview status - Clean up Setup section - Add CLI.md - Move crawl instructions to CLI.md --------- Co-authored-by: Liam Thompson <32779855+leemthompo@users.noreply.github.com>
Backports the following commits to 0.1: - Improve setup docs and add CLI docs (#44) Co-authored-by: Navarone Feekery <13634519+navarone-feekery@users.noreply.github.com> Co-authored-by: Liam Thompson <32779855+leemthompo@users.noreply.github.com>