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

Improve setup docs and add CLI docs #44

Merged
merged 9 commits into from
Jun 7, 2024

Conversation

navarone-feekery
Copy link
Collaborator

  • Add version compatibility
  • Add tech-preview status
  • Clean up Setup section
  • Add CLI.md
  • Move crawl instructions to CLI.md

@navarone-feekery navarone-feekery marked this pull request as ready for review June 7, 2024 10:14
@navarone-feekery navarone-feekery requested a review from a team June 7, 2024 10:14
@navarone-feekery
Copy link
Collaborator Author

navarone-feekery commented Jun 7, 2024

@danajuratoni I will add a feature comparison table in a different PR

Copy link
Contributor

@leemthompo leemthompo left a 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.

navarone-feekery and others added 2 commits June 7, 2024 13:27
Co-authored-by: Liam Thompson <32779855+leemthompo@users.noreply.github.com>
Copy link
Contributor

@leemthompo leemthompo left a 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. :)

@navarone-feekery
Copy link
Collaborator Author

@leemthompo thanks for all the feedback, it's really valuable. I think everything is addressed now.

leemthompo
leemthompo previously approved these changes Jun 7, 2024
Copy link
Contributor

@leemthompo leemthompo left a 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>
@navarone-feekery navarone-feekery enabled auto-merge (squash) June 7, 2024 14:45
@navarone-feekery navarone-feekery merged commit ea8e29e into main Jun 7, 2024
2 checks passed
@navarone-feekery navarone-feekery deleted the navarone/update-documentation branch June 7, 2024 14:46
github-actions bot pushed a commit that referenced this pull request Jun 17, 2024
- 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>
navarone-feekery added a commit that referenced this pull request Jun 17, 2024
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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants