Skip to content

docs: Update all user guide intros - #3580

Merged
SuaYoo merged 1 commit into
mainfrom
docs-user-guide-hero
Aug 31, 2026
Merged

docs: Update all user guide intros#3580
SuaYoo merged 1 commit into
mainfrom
docs-user-guide-hero

Conversation

@SuaYoo

@SuaYoo SuaYoo commented Aug 17, 2026

Copy link
Copy Markdown
Member

Related to #2304

Changes

  • Updates all user guide page intros:
    • Summarizes the topic in a non-technical way
    • Standardize the documentation of which web app pages the topic is most relevant
    • Better support link previews (see screenshots)
  • Adds link to Webrecorder public archives as collection live demos

Screenshots

Link previews

Screenshot 2026-08-17 at 10 10 04 AM Screenshot 2026-08-17 at 10 10 23 AM Screenshot 2026-08-17 at 10 10 28 AM

"Public Collections Gallery" page

Screenshot 2026-08-17 at 10 10 51 AM

"Intro to Crawl Workflows" page

Screenshot 2026-08-17 at 10 09 52 AM

Stack created with GitHub Stacks CLIGive Feedback 💬

@SuaYoo
SuaYoo force-pushed the docs-user-guide-hero branch from f3d8708 to 7aeaa02 Compare August 19, 2026 03:14
@SuaYoo
SuaYoo force-pushed the docs-user-guide-hero branch from 7aeaa02 to 5d97374 Compare August 19, 2026 16:46
@SuaYoo
SuaYoo force-pushed the docs-user-guide-hero branch 2 times, most recently from c674bb8 to c366e3b Compare August 19, 2026 18:12
@SuaYoo
SuaYoo force-pushed the docs-user-guide-hero branch from c366e3b to c25ba9e Compare August 19, 2026 21:17
@SuaYoo
SuaYoo force-pushed the docs-user-guide-hero branch from c25ba9e to 2298a5b Compare August 19, 2026 21:25
@SuaYoo
SuaYoo force-pushed the docs-user-guide-hero branch from 2298a5b to 964a037 Compare August 24, 2026 18:04
@SuaYoo
SuaYoo force-pushed the docs-user-guide-hero branch from 964a037 to c74178e Compare August 25, 2026 19:31

@emma-sg emma-sg left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Left a few comments/suggestions, but looks good overall!

Comment thread frontend/docs/docs/user-guide/archived-items.md
## Uploading Web Archives

WACZ files can be given metadata and uploaded to Browsertrix by pressing the _Upload WACZ_ button on the archived items list page. Only one WACZ file can be uploaded at a time.
To import an archived item, use the _Upload WACZ_ button on the **Archived Items** page. Metadata like name, tags, and collection can be assigned during import. Only archived items in the WACZ file format are accepted.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Do you think it'd be worth it'd be mentioning how to convert other archive formats to wacz here?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

I don't actually know how to do that either, so yes! Where is this documented?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Easiest way to package WARCs into a WACZ that we support is to use https://github.com/webrecorder/py-wacz :)

Other web archive formats like ARC files are a little trickier but I think rare enough at this point that it's unlikely someone would have them and not know how to deal with them.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Addressed in #3611

Screenshot 2026-08-31 at 12 03 30 PM

Comment thread frontend/docs/docs/user-guide/archived-items.md
Comment thread frontend/docs/docs/user-guide/archived-items.md
Comment thread frontend/docs/docs/user-guide/collection.md
Comment thread frontend/docs/docs/user-guide/crawl-workflows.md
@SuaYoo
SuaYoo force-pushed the docs-user-guide-hero branch from c74178e to 62ea2d4 Compare August 27, 2026 04:43
@SuaYoo
SuaYoo force-pushed the docs-user-guide-hero branch from 62ea2d4 to 6d93289 Compare August 27, 2026 04:44
Base automatically changed from docs-user-guide-ctas to main August 27, 2026 04:44
@SuaYoo
SuaYoo force-pushed the docs-user-guide-hero branch 3 times, most recently from 847f0d3 to 420cb1a Compare August 28, 2026 03:41
@SuaYoo
SuaYoo force-pushed the docs-user-guide-hero branch 2 times, most recently from d62071d to c4335ec Compare August 30, 2026 19:28
@SuaYoo
SuaYoo force-pushed the docs-user-guide-hero branch from c4335ec to e02b8f1 Compare August 30, 2026 19:30
@SuaYoo
SuaYoo merged commit e81317e into main Aug 31, 2026
24 checks passed
@SuaYoo
SuaYoo deleted the docs-user-guide-hero branch August 31, 2026 19:25
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.

3 participants