From 2773bc93027f6d0fdcc86fc0f41e888be352d9c9 Mon Sep 17 00:00:00 2001 From: Henry Wilkinson Date: Wed, 26 Feb 2025 22:47:05 -0500 Subject: [PATCH 1/5] Add developemnt docs section on dropdown action order --- .../docs/develop/design-actions-dropdown.md | 21 +++++++++++++++++++ frontend/docs/mkdocs.yml | 2 ++ 2 files changed, 23 insertions(+) create mode 100644 frontend/docs/docs/develop/design-actions-dropdown.md diff --git a/frontend/docs/docs/develop/design-actions-dropdown.md b/frontend/docs/docs/develop/design-actions-dropdown.md new file mode 100644 index 0000000000..ec38860434 --- /dev/null +++ b/frontend/docs/docs/develop/design-actions-dropdown.md @@ -0,0 +1,21 @@ +# Actions Dropdowns + +While controls are always placed next to the most relevant content area, we expose most controls for an object in an _Actions_ dropdown menu to enable discovery of actions in a single place, and allow power-users to quickly accomplish tasks. + +## Implementation + +Actions dropdowns should generally contain a consistent set of actions for a given object. Whereas `---` symbolizes a horizontal separator, these actions should be ordered as follows: + +```txt +Actions related only to the current page (remove from collection) +--- +Actions related to editing the object +Other actions related to the current object +--- +Actions related to exporting/downloading +--- +Copy information to clipboard +Copy IDs to clipboard +--- +Destructive actions +``` diff --git a/frontend/docs/mkdocs.yml b/frontend/docs/mkdocs.yml index 5ee2a33173..2a9b43c2d1 100644 --- a/frontend/docs/mkdocs.yml +++ b/frontend/docs/mkdocs.yml @@ -91,6 +91,8 @@ nav: - develop/frontend-dev.md - develop/localization.md - develop/docs.md + - Design: + - develop/design-actions-dropdown.md - API Reference: !ENV [ API_DOCS_URL, "/api/" ] From 7198d280fe8f6ac50ded1517b1c07d377591d55b Mon Sep 17 00:00:00 2001 From: Henry Wilkinson Date: Wed, 26 Feb 2025 23:01:40 -0500 Subject: [PATCH 2/5] Adds examples to all actions --- .../docs/docs/develop/design-actions-dropdown.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/frontend/docs/docs/develop/design-actions-dropdown.md b/frontend/docs/docs/develop/design-actions-dropdown.md index ec38860434..292502672b 100644 --- a/frontend/docs/docs/develop/design-actions-dropdown.md +++ b/frontend/docs/docs/develop/design-actions-dropdown.md @@ -7,15 +7,15 @@ While controls are always placed next to the most relevant content area, we expo Actions dropdowns should generally contain a consistent set of actions for a given object. Whereas `---` symbolizes a horizontal separator, these actions should be ordered as follows: ```txt -Actions related only to the current page (remove from collection) +Actions related only to the current page (eg: remove archived item from collection) --- -Actions related to editing the object -Other actions related to the current object +Actions related to editing the object (eg: edit workflow config, edit item metadata) +Other actions related to the current object (eg: run crawl) --- -Actions related to exporting/downloading +Actions related to exporting/downloading (eg: download archived item) --- -Copy information to clipboard -Copy IDs to clipboard +Copy information to clipboard (eg: copy share link) +Copy IDs to clipboard (eg: copy item ID) --- -Destructive actions +Destructive actions (eg: delete item) ``` From 68465d87c60c63e8e34ea9cf4f152a8090d011af Mon Sep 17 00:00:00 2001 From: Henry Wilkinson Date: Mon, 3 Mar 2025 13:42:50 -0500 Subject: [PATCH 3/5] Clarify links in menus, rename file --- .../{design-actions-dropdown.md => design-action-menus.md} | 6 ++++-- frontend/docs/mkdocs.yml | 2 +- 2 files changed, 5 insertions(+), 3 deletions(-) rename frontend/docs/docs/develop/{design-actions-dropdown.md => design-action-menus.md} (62%) diff --git a/frontend/docs/docs/develop/design-actions-dropdown.md b/frontend/docs/docs/develop/design-action-menus.md similarity index 62% rename from frontend/docs/docs/develop/design-actions-dropdown.md rename to frontend/docs/docs/develop/design-action-menus.md index 292502672b..b910c59c44 100644 --- a/frontend/docs/docs/develop/design-actions-dropdown.md +++ b/frontend/docs/docs/develop/design-action-menus.md @@ -1,10 +1,12 @@ -# Actions Dropdowns +# Action Menus While controls are always placed next to the most relevant content area, we expose most controls for an object in an _Actions_ dropdown menu to enable discovery of actions in a single place, and allow power-users to quickly accomplish tasks. +We try to avoid surfacing navigation options in action menus as they are not tagged as navigation elements. Sometimes we expose links here for convenience, but navigating to another page should never only be possible through an actions menu. + ## Implementation -Actions dropdowns should generally contain a consistent set of actions for a given object. Whereas `---` symbolizes a horizontal separator, these actions should be ordered as follows: +Action menus should generally contain a consistent set of actions for a given object. Whereas `---` symbolizes a horizontal separator, these actions should be ordered as follows: ```txt Actions related only to the current page (eg: remove archived item from collection) diff --git a/frontend/docs/mkdocs.yml b/frontend/docs/mkdocs.yml index 2a9b43c2d1..69a3a24832 100644 --- a/frontend/docs/mkdocs.yml +++ b/frontend/docs/mkdocs.yml @@ -92,7 +92,7 @@ nav: - develop/localization.md - develop/docs.md - Design: - - develop/design-actions-dropdown.md + - develop/design-actions-menu.md - API Reference: !ENV [ API_DOCS_URL, "/api/" ] From 542c7e8d225ab05474049627adb9d2c0cd02e3c4 Mon Sep 17 00:00:00 2001 From: Henry Wilkinson Date: Mon, 3 Mar 2025 14:33:33 -0500 Subject: [PATCH 4/5] fix name change --- frontend/docs/mkdocs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/frontend/docs/mkdocs.yml b/frontend/docs/mkdocs.yml index 69a3a24832..094aa0f0b1 100644 --- a/frontend/docs/mkdocs.yml +++ b/frontend/docs/mkdocs.yml @@ -92,7 +92,7 @@ nav: - develop/localization.md - develop/docs.md - Design: - - develop/design-actions-menu.md + - develop/design-action-menus.md - API Reference: !ENV [ API_DOCS_URL, "/api/" ] From 6b5f4be6c1ecab7b118a963209f6775953c94cab Mon Sep 17 00:00:00 2001 From: Henry Wilkinson Date: Wed, 5 Mar 2025 18:02:32 -0500 Subject: [PATCH 5/5] Fix em dash --- frontend/docs/docs/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/frontend/docs/docs/index.md b/frontend/docs/docs/index.md index 1b194ce8ed..04ef89cf25 100644 --- a/frontend/docs/docs/index.md +++ b/frontend/docs/docs/index.md @@ -15,7 +15,7 @@ Docs are organized into the following sections: - [User Guide](./user-guide/index.md) — Instructions on how to use Browsertrix to create and share web archives. - [Self-Hosting](./deploy/index.md) — Instructions on how to install, set up, and deploy self-hosted Browsertrix. - [Development](./develop/index.md) — Contribute to the open source development of Browsertrix software. -- [API Reference](/api) - Full API reference for interacting with the Browsertrix backend. +- [API Reference](/api) — Full API reference for interacting with the Browsertrix backend. If you have feedback on the docs, please feel free to [reach out to us](mailto:docs-feedback@webrecorder.net).