diff --git a/frontend/docs/docs/develop/design-action-menus.md b/frontend/docs/docs/develop/design-action-menus.md new file mode 100644 index 0000000000..b910c59c44 --- /dev/null +++ b/frontend/docs/docs/develop/design-action-menus.md @@ -0,0 +1,23 @@ +# 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 + +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) +--- +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 (eg: download archived item) +--- +Copy information to clipboard (eg: copy share link) +Copy IDs to clipboard (eg: copy item ID) +--- +Destructive actions (eg: delete item) +``` 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). diff --git a/frontend/docs/mkdocs.yml b/frontend/docs/mkdocs.yml index 5ee2a33173..094aa0f0b1 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-action-menus.md - API Reference: !ENV [ API_DOCS_URL, "/api/" ]