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

Update documentation for 1.0.0 #493

Closed
tw4l opened this issue Mar 13, 2024 · 0 comments · Fixed by #494
Closed

Update documentation for 1.0.0 #493

tw4l opened this issue Mar 13, 2024 · 0 comments · Fixed by #494
Assignees
@tw4l
Labels
documentation Improvements or additions to documentation

Comments

@tw4l
Copy link
Contributor

tw4l commented Mar 13, 2024

  • Ensure documentation is accurate
  • Move documentation from README to proper docs site
@tw4l tw4l self-assigned this Mar 13, 2024
@tw4l tw4l added the documentation Improvements or additions to documentation label Mar 13, 2024
@tw4l tw4l mentioned this issue Mar 13, 2024
Merged
ikreymer added a commit that referenced this issue Mar 16, 2024
@tw4l @Shrinks99 @ikreymer
Add MKDocs documentation site for Browsertrix Crawler 1.0.0 (#494)
e1fe028 
Fixes #493 

This PR updates the documentation for Browsertrix Crawler 1.0.0 and
moves it from the project README to an MKDocs site.

Initial docs site set to https://crawler.docs.browsertrix.com/

Many thanks to @Shrinks99 for help setting this up!

---------

Co-authored-by: Henry Wilkinson <henry@wilkinson.graphics>
Co-authored-by: Ilya Kreymer <ikreymer@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@tw4l tw4l

Labels
documentation Improvements or additions to documentation
Projects
Webrecorder Projects
Status: Done!
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add MKDocs documentation site for Browsertrix Crawler 1.0.0 webrecorder/browsertrix-crawler
1 participant
@tw4l