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

Add MKDocs documentation site for Browsertrix Crawler 1.0.0 #494

Merged
merged 37 commits into from Mar 16, 2024
Merged

Add MKDocs documentation site for Browsertrix Crawler 1.0.0 #494

merged 37 commits into from Mar 16, 2024

Commits on Mar 13, 2024

  1. WIP: First pass at mkdocs

    @tw4l
    tw4l committed Mar 13, 2024
    Configuration menu
    Copy the full SHA
    8e68ee3 View commit details
    Browse the repository at this point in the history

  2. Specify src dir for linting and formatting

    @tw4l
    tw4l committed Mar 13, 2024
    Configuration menu
    Copy the full SHA
    0f7d736 View commit details
    Browse the repository at this point in the history

  3. Update docs and README

    @tw4l
    tw4l committed Mar 13, 2024
    Configuration menu
    Copy the full SHA
    3231e72 View commit details
    Browse the repository at this point in the history

  4. Adds logos to docs

    @Shrinks99
    Shrinks99 committed Mar 13, 2024
    Configuration menu
    Copy the full SHA
    eed8820 View commit details
    Browse the repository at this point in the history

  5. Remove venv from git repo

    @tw4l
    tw4l committed Mar 13, 2024
    Configuration menu
    Copy the full SHA
    ea70159 View commit details
    Browse the repository at this point in the history

  6. Fix typo

    @tw4l
    tw4l committed Mar 13, 2024
    Configuration menu
    Copy the full SHA
    c3f6bb4 View commit details
    Browse the repository at this point in the history

  7. Update link

    @tw4l
    tw4l committed Mar 13, 2024
    Configuration menu
    Copy the full SHA
    21fc0b6 View commit details
    Browse the repository at this point in the history

  8. Add CNAME for crawler-docs.browsertrix.com

    @tw4l
    tw4l committed Mar 13, 2024
    Configuration menu
    Copy the full SHA
    b21f5b8 View commit details
    Browse the repository at this point in the history

  9. Add GH Actions workflow to publish docs

    @tw4l
    tw4l committed Mar 13, 2024
    Configuration menu
    Copy the full SHA
    16a2022 View commit details
    Browse the repository at this point in the history

  10. Modify docs url to crawler-docs.webrecorder.net for now

    @tw4l
    tw4l committed Mar 13, 2024
    Configuration menu
    Copy the full SHA
    9bdb2e8 View commit details
    Browse the repository at this point in the history

  11. Add mentions of collecting data from CDP

    @tw4l
    tw4l committed Mar 13, 2024
    Configuration menu
    Copy the full SHA
    46fe56a View commit details
    Browse the repository at this point in the history

  12. Fix typo

    @tw4l
    tw4l committed Mar 13, 2024
    Configuration menu
    Copy the full SHA
    41948e7 View commit details
    Browse the repository at this point in the history

  13. Remove unused icons

    @tw4l
    tw4l committed Mar 13, 2024
    Configuration menu
    Copy the full SHA
    ecba2f0 View commit details
    Browse the repository at this point in the history

  14. Updates colours 

    - Reorders main nav
    @Shrinks99
    Shrinks99 committed Mar 13, 2024
    Configuration menu
    Copy the full SHA
    011286f View commit details
    Browse the repository at this point in the history

  15. Fixes em dashes, adds oxford comma

    @Shrinks99
    Shrinks99 committed Mar 13, 2024
    Configuration menu
    Copy the full SHA
    3529686 View commit details
    Browse the repository at this point in the history

  16. Fixes em dashes

    @Shrinks99
    Shrinks99 committed Mar 13, 2024
    Configuration menu
    Copy the full SHA
    6f9fadf View commit details
    Browse the repository at this point in the history

  17. Fixes line breaks, adds em dash

    @Shrinks99
    Shrinks99 committed Mar 13, 2024
    Configuration menu
    Copy the full SHA
    9c06d43 View commit details
    Browse the repository at this point in the history

Commits on Mar 14, 2024

  1. Apply style changes to text 

    Co-authored-by: Henry Wilkinson <henry@wilkinson.graphics>
    @tw4l @Shrinks99
    tw4l and Shrinks99 committed Mar 14, 2024
    Configuration menu
    Copy the full SHA
    fad2bda View commit details
    Browse the repository at this point in the history

  2. Remove insertversion js

    @tw4l
    tw4l committed Mar 14, 2024
    Configuration menu
    Copy the full SHA
    2ca1e67 View commit details
    Browse the repository at this point in the history

  3. Clarify headless profile streaming

    @tw4l
    tw4l committed Mar 14, 2024
    Configuration menu
    Copy the full SHA
    0b2e91e View commit details
    Browse the repository at this point in the history

  4. Use example admonition

    @tw4l
    tw4l committed Mar 14, 2024
    Configuration menu
    Copy the full SHA
    5cf3f8d View commit details
    Browse the repository at this point in the history

  5. Remove errant backticks

    @tw4l
    tw4l committed Mar 14, 2024
    Configuration menu
    Copy the full SHA
    a044a86 View commit details
    Browse the repository at this point in the history

  6. Fix unclear sentence

    @tw4l
    tw4l committed Mar 14, 2024
    Configuration menu
    Copy the full SHA
    b68c4b6 View commit details
    Browse the repository at this point in the history

  7. Adds oxford comma and em dash 

    Further clarifies extra hops language
    @Shrinks99
    Shrinks99 committed Mar 14, 2024
    Configuration menu
    Copy the full SHA
    4495a24 View commit details
    Browse the repository at this point in the history

  8. Removes double space

    @Shrinks99
    Shrinks99 committed Mar 14, 2024
    Configuration menu
    Copy the full SHA
    3b6afaf View commit details
    Browse the repository at this point in the history

  9. Adds dark mode favicon colors

    @Shrinks99
    Shrinks99 committed Mar 14, 2024
    Configuration menu
    Copy the full SHA
    941fd7b View commit details
    Browse the repository at this point in the history

  10. Updates favicon with dynamic color for dark mode

    @Shrinks99
    Shrinks99 committed Mar 14, 2024
    Configuration menu
    Copy the full SHA
    516c966 View commit details
    Browse the repository at this point in the history

  11. SVG optimization

    @Shrinks99
    Shrinks99 committed Mar 14, 2024
    Configuration menu
    Copy the full SHA
    ef707df View commit details
    Browse the repository at this point in the history

Commits on Mar 15, 2024

  1. add gen-cli.sh script to auto-generated the cli-options.md 

    add docs for installing docs
tweaks to README
    @ikreymer
    ikreymer committed Mar 15, 2024
    Configuration menu
    Copy the full SHA
    edaa07b View commit details
    Browse the repository at this point in the history

  2. test publishing, update CNAME

    @ikreymer
    ikreymer committed Mar 15, 2024
    Configuration menu
    Copy the full SHA
    4cbd446 View commit details
    Browse the repository at this point in the history

  3. test publish

    @ikreymer
    ikreymer committed Mar 15, 2024
    Configuration menu
    Copy the full SHA
    dc00f03 View commit details
    Browse the repository at this point in the history

  4. fix typo

    @ikreymer
    ikreymer committed Mar 15, 2024
    Configuration menu
    Copy the full SHA
    d223836 View commit details
    Browse the repository at this point in the history

  5. add missing docs.md

    @ikreymer
    ikreymer committed Mar 15, 2024
    Configuration menu
    Copy the full SHA
    3753f57 View commit details
    Browse the repository at this point in the history

  6. fix docs link

    @ikreymer
    ikreymer committed Mar 15, 2024
    Configuration menu
    Copy the full SHA
    8841275 View commit details
    Browse the repository at this point in the history

  7. Update Crawl Scope section with better regex examples 

    Co-authored by @pato-pan
    @tw4l
    tw4l committed Mar 15, 2024
    Configuration menu
    Copy the full SHA
    17de513 View commit details
    Browse the repository at this point in the history

  8. Update link in README to docs to make CNAME

    @tw4l
    tw4l committed Mar 15, 2024
    Configuration menu
    Copy the full SHA
    916c434 View commit details
    Browse the repository at this point in the history

Commits on Mar 16, 2024

  1. remove test publish branch, remove dupe CNAME

    @ikreymer
    ikreymer committed Mar 16, 2024
    Configuration menu
    Copy the full SHA
    ab21d67 View commit details
    Browse the repository at this point in the history