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.

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

docs: add development section on action menus #2429

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions frontend/docs/docs/develop/design-action-menus.md
Original file line number Diff line number Diff line change
@@ -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)
```
2 changes: 1 addition & 1 deletion frontend/docs/docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).

Expand Down
2 changes: 2 additions & 0 deletions frontend/docs/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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/" ]

Expand Down
Loading