Skip to content

docs: Document concepts and terms in user guide - #3611

Open
SuaYoo wants to merge 5 commits into
frontend-onboarding-analyticsfrom
docs-user-guide-concepts
Open

docs: Document concepts and terms in user guide#3611
SuaYoo wants to merge 5 commits into
frontend-onboarding-analyticsfrom
docs-user-guide-concepts

Conversation

@SuaYoo

@SuaYoo SuaYoo commented Aug 27, 2026

Copy link
Copy Markdown
Member

Partially addresses #2304

Changes

  • Documents high level concepts and terminology in the user guide so that it can be linked from the dashboard. Term definitions are copied from https://webrecorder.net/resources/glossary/ with some modification to help flow from one concept to another.
  • Better icon for "Getting started"

Manual testing

Read here.

Screenshots

Page Image/video
User Guide Screenshot 2026-08-27 at 5 35 00 PM
User Guide Screenshot 2026-08-27 at 5 37 25 PM

Stack created with GitHub Stacks CLIGive Feedback 💬

@SuaYoo
SuaYoo force-pushed the docs-user-guide-concepts branch from a2e2df9 to 0e1c030 Compare August 28, 2026 00:16
@SuaYoo
SuaYoo marked this pull request as ready for review August 28, 2026 00:38
@SuaYoo
SuaYoo force-pushed the docs-user-guide-concepts branch from 0e1c030 to fc8d8f9 Compare August 28, 2026 03:41

## WACZ File

WACZ (Web Archive Collection Zipped) is an open source format developed by Webrecorder that enables contextualized, interactive playback of a web archive.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

It may be worth briefly mentioning WACZ's relationship to WARC? I think we may have some users coming here with some familiarity with WARC but not WACZ.

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.

Expanded upon WACZ and related concepts using some language from the specs 807ddbf

Screenshot 2026-08-30 at 3 36 20 PM

Feel free to make direct adjustments.

@SuaYoo
SuaYoo force-pushed the docs-user-guide-concepts branch from fc8d8f9 to 1e5f8aa Compare August 28, 2026 19:48
@SuaYoo
SuaYoo force-pushed the docs-user-guide-concepts branch from 1e5f8aa to 4452e59 Compare August 30, 2026 19:28
@SuaYoo
SuaYoo force-pushed the docs-user-guide-concepts branch from 4452e59 to 4889388 Compare August 30, 2026 19:30
@SuaYoo
SuaYoo requested a review from mistydemeo August 31, 2026 18:46
@SuaYoo
SuaYoo force-pushed the docs-user-guide-concepts branch from f1945fd to bad0bb9 Compare August 31, 2026 19:25
@SuaYoo
SuaYoo force-pushed the docs-user-guide-concepts branch 2 times, most recently from 17eba44 to f02e636 Compare August 31, 2026 20:02
@SuaYoo
SuaYoo force-pushed the docs-user-guide-concepts branch from f02e636 to 5a29c05 Compare September 1, 2026 15:27
@SuaYoo
SuaYoo force-pushed the docs-user-guide-concepts branch from 5a29c05 to 1e81ca8 Compare September 1, 2026 17:57
@SuaYoo
SuaYoo force-pushed the docs-user-guide-concepts branch from 1e81ca8 to 062bbc9 Compare September 1, 2026 19:43
@SuaYoo
SuaYoo force-pushed the docs-user-guide-concepts branch from 062bbc9 to 37f4390 Compare September 1, 2026 21:39
@SuaYoo
SuaYoo force-pushed the docs-user-guide-concepts branch from 37f4390 to aa3387d Compare September 2, 2026 16:30
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.

2 participants