Summary

Add documentation on the Quick Access review actions.

Review Request #15069 — Created May 20, 2026 and submitted May 25, 2026, 7:20 p.m.

Information

Owner

chipx86

Repository

Review Board

Branch

release-8.x

Bugs

Depends On

Reviewers

Groups

reviewboard

People

Description

This updates the Review Banner docs to discuss the Quick Access actions,
discussing how they work and what actions are available by default.

Some bits of the Review Banner docs were updated while here to improve
navigation and anchoring.

The action extension docs have also been updated to discuss how to
create custom actions for inclusion in the list, with an example of a
custom one.

The screenshots on the page have also been updated to reflect both the
current color palette and the Quick Access UI.

Testing Done

Built the docs. Checked for any obvious errors.

Tested the screenshots on a standard and retina display.

Commits

Summary	ID
Add documentation on the Quick Access review actions. This updates the Review Banner docs to discuss the Quick Access actions, discussing how they work and what actions are available by default. Some bits of the Review Banner docs were updated while here to improve navigation and anchoring. The action extension docs have also been updated to discuss how to create custom actions for inclusion in the list, with an example of a custom one. The screenshots on the page have also been updated to reflect both the current color palette and the Quick Access UI. The `description` attribute on `BaseAction` has been officially added, typed, and documented. This is used for both button tooltips and detailed menu item text, and may be used for other renders as well.	b2f54e66608592c41776d0dfe16e8268665744e2

Summary

Add documentation on the Quick Access review actions.

This updates the Review Banner docs to discuss the Quick Access actions, discussing how they work and what actions are available by default. Some bits of the Review Banner docs were updated while here to improve navigation and anchoring. The action extension docs have also been updated to discuss how to create custom actions for inclusion in the list, with an example of a custom one. The screenshots on the page have also been updated to reflect both the current color palette and the Quick Access UI. The `description` attribute on `BaseAction` has been officially added, typed, and documented. This is used for both button tooltips and detailed menu item text, and may be used for other renders as well.

b2f54e66608592c41776d0dfe16e8268665744e2

Issues

Description	From	Last Updated
description isn't actually a formal property of BaseAction. We probably should make it so, but at least for now we …	david	May 20, 2026, 10 p.m.
We're using the same term in its own definition. In banner.rst you say "one-click access" which might be nice to …	david	May 20, 2026, 10:01 p.m.
Quick Actions -> Quick Access actions	david	May 20, 2026, 10:01 p.m.
Typo: Markkdown -> Markdown	david	May 20, 2026, 10:01 p.m.
typo: and link -> and a link	david	May 20, 2026, 10:01 p.m.
"Quick Access" should be capitalized here.	david	May 20, 2026, 10:03 p.m.
Typo: pargraph -> paragraph	david	May 25, 2026, 2:50 p.m.
Can we clarify in here that this description text is plain text that will be escaped before display?	david	May 25, 2026, 2:51 p.m.
Shouldn't this reference review-banner-menu?	david	May 25, 2026, 2:51 p.m.
This can be :py:attr:`~reviewboard.actions.base.BaseAction.description` now.	maubin	May 25, 2026, 2:50 p.m.
Can we also add this? See :ref:`extension-actions-quick-access` about writing custom Quick Access actions.	david	May 25, 2026, 2:52 p.m.
Can we clarify in here that this description text is plain text that will be escaped before display?	david	May 25, 2026, 2:53 p.m.
Shouldn't this reference review-banner-menu?	david	May 25, 2026, 2:53 p.m.

flake8 passed.

JSHint passed.

docs/manual/extending/extensions/actions.rst (Diff revision 1)

The issue has been resolved. Show all issues

description isn't actually a formal property of BaseAction. We probably should make it so, but at least for now we should document that this only applies to actions rendered by DetailedMenuItemActionRenderer

chipx86

May 20, 2026, 10:04 p.m.

It's used by buttons and menu items both. It's the title attribute for buttons. I'll make it part of the base class.

docs/manual/glossary.rst (Diff revision 1)

The issue has been resolved. Show all issues

We're using the same term in its own definition. In banner.rst you say "one-click access" which might be nice to use here too.

docs/manual/users/reviews/banner.rst (Diff revision 1)
The issue has been resolved. Show all issues
```
Quick Actions -> Quick Access actions
```
docs/manual/users/reviews/banner.rst (Diff revision 1)
The issue has been resolved. Show all issues
```
Typo: Markkdown -> Markdown
```
docs/manual/users/reviews/banner.rst (Diff revision 1)
The issue has been resolved. Show all issues
```
typo: and link -> and a link
```
docs/manual/users/reviews/banner.rst (Diff revision 1)
The issue has been resolved. Show all issues
```
"Quick Access" should be capitalized here.
```

Change Summary:


Fixed several typos.
Improved wording in places.
Added a formal BaseAction.description attribute, since this is used for multiple renderers.

Commits:

	Summary	ID
	Add documentation on the Quick Access review actions. This updates the Review Banner docs to discuss the Quick Access actions, discussing how they work and what actions are available by default. Some bits of the Review Banner docs were updated while here to improve navigation and anchoring. The action extension docs have also been updated to discuss how to create custom actions for inclusion in the list, with an example of a custom one. The screenshots on the page have also been updated to reflect both the current color palette and the Quick Access UI.	a1409f9aaf6c35545173a8afb11adba2bd82c08c
	Add documentation on the Quick Access review actions. This updates the Review Banner docs to discuss the Quick Access actions, discussing how they work and what actions are available by default. Some bits of the Review Banner docs were updated while here to improve navigation and anchoring. The action extension docs have also been updated to discuss how to create custom actions for inclusion in the list, with an example of a custom one. The screenshots on the page have also been updated to reflect both the current color palette and the Quick Access UI. The `description` attribute on `BaseAction` has been officially added, typed, and documented. This is used for both button tooltips and detailed menu item text, and may be used for other renders as well.	78da19872f70ab08a8b7c55d0b013c18a64395c0

Diff:

Revision 2 (+392 -18)

Show changes

	docs/manual/glossary.rst
	docs/manual/extending/extensions/actions.rst
	docs/manual/users/reviews/banner.rst
	docs/manual/users/reviews/review-banner-draft.png
	docs/manual/users/reviews/review-banner-draft@2x.png
	docs/manual/users/reviews/review-banner-grouped.png
	docs/manual/users/reviews/review-banner-grouped@2x.png
	docs/manual/users/reviews/review-banner-quick-access.png
	2 more

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

docs/manual/extending/extensions/actions.rst (Diff revision 2)

The issue has been resolved. Show all issues

This can be

:py:attr:`~reviewboard.actions.base.BaseAction.description`

now.

docs/manual/extending/extensions/actions.rst (Diff revision 2)
The issue has been resolved. Show all issues
```
Typo: pargraph -> paragraph
```

docs/manual/extending/extensions/actions.rst (Diff revision 2)

The issue has been resolved. Show all issues

Can we clarify in here that this description text is plain text that will be escaped before display?

docs/manual/extending/extensions/actions.rst (Diff revision 2)
The issue has been resolved. Show all issues
```
Shouldn't this reference review-banner-menu?
```

docs/manual/glossary.rst (Diff revision 2)

The issue has been resolved. Show all issues

Can we also add this?

See :ref:`extension-actions-quick-access` about writing custom Quick Access actions.

reviewboard/actions/base.py (Diff revision 2)

The issue has been resolved. Show all issues

Can we clarify in here that this description text is plain text that will be escaped before display?

reviewboard/actions/base.py (Diff revision 2)
The issue has been resolved. Show all issues
```
Shouldn't this reference review-banner-menu?
```

Change Summary:


Fixed and added references.
Fixed a typo.
Updated description paragraph docs to state that each string is plain text and will be escaped.

Commits:

	Summary	ID
	Add documentation on the Quick Access review actions. This updates the Review Banner docs to discuss the Quick Access actions, discussing how they work and what actions are available by default. Some bits of the Review Banner docs were updated while here to improve navigation and anchoring. The action extension docs have also been updated to discuss how to create custom actions for inclusion in the list, with an example of a custom one. The screenshots on the page have also been updated to reflect both the current color palette and the Quick Access UI. The `description` attribute on `BaseAction` has been officially added, typed, and documented. This is used for both button tooltips and detailed menu item text, and may be used for other renders as well.	78da19872f70ab08a8b7c55d0b013c18a64395c0
	Add documentation on the Quick Access review actions. This updates the Review Banner docs to discuss the Quick Access actions, discussing how they work and what actions are available by default. Some bits of the Review Banner docs were updated while here to improve navigation and anchoring. The action extension docs have also been updated to discuss how to create custom actions for inclusion in the list, with an example of a custom one. The screenshots on the page have also been updated to reflect both the current color palette and the Quick Access UI. The `description` attribute on `BaseAction` has been officially added, typed, and documented. This is used for both button tooltips and detailed menu item text, and may be used for other renders as well.	b2f54e66608592c41776d0dfe16e8268665744e2

Diff:

Revision 3 (+406 -18)

Show changes

	docs/manual/glossary.rst
	docs/manual/extending/extensions/actions.rst
	docs/manual/users/reviews/banner.rst
	docs/manual/users/reviews/review-banner-draft.png
	docs/manual/users/reviews/review-banner-draft@2x.png
	docs/manual/users/reviews/review-banner-grouped.png
	docs/manual/users/reviews/review-banner-grouped@2x.png
	docs/manual/users/reviews/review-banner-quick-access.png
	2 more

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

```
Ship It!
```

Status:: Completed
Change Summary:: Pushed to release-8.x (e8171ec)