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

Add crawler QA docs #551

Merged
merged 14 commits into from
Apr 18, 2024
Merged

Add crawler QA docs #551

merged 14 commits into from
Apr 18, 2024

Conversation

tw4l
Copy link
Contributor

@tw4l tw4l commented Apr 18, 2024

Fixes #550

@tw4l tw4l requested review from ikreymer and Shrinks99 April 18, 2024 14:36
docs/docs/user-guide/qa.md Outdated Show resolved Hide resolved
Copy link
Member

@Shrinks99 Shrinks99 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice!!

docs/docs/user-guide/qa.md Outdated Show resolved Hide resolved
docs/docs/index.md Outdated Show resolved Hide resolved

!!! note

QA features described on this page are available in Browsertrix Crawler releases 1.1.0 and later.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess these are good because we don't version our docs? No harm in them really, though as we add new features and reference them on pages like this, they run the risk of going out of date?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, probably don't wanna go crazy with this but it's also worth flagging since this is a big feature that doesn't exist in older releases I think.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You're right that better docs versioning would definitely help!

docs/docs/user-guide/qa.md Outdated Show resolved Hide resolved
docs/docs/user-guide/qa.md Outdated Show resolved Hide resolved
docs/docs/user-guide/qa.md Outdated Show resolved Hide resolved
docs/docs/user-guide/qa.md Outdated Show resolved Hide resolved
docs/docs/user-guide/qa.md Outdated Show resolved Hide resolved
docs/docs/user-guide/qa.md Outdated Show resolved Hide resolved
Co-authored-by: Henry Wilkinson <henry@wilkinson.graphics>
@tw4l tw4l requested a review from Shrinks99 April 18, 2024 19:21
Copy link
Member

@Shrinks99 Shrinks99 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great! Thanks for putting this together!

@tw4l tw4l merged commit 75b617d into main Apr 18, 2024
4 checks passed
@tw4l tw4l deleted the qa-docs branch April 18, 2024 20:18
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.

Add documentation for QA!
3 participants