Summary

Add a comprehensive guide on the actions framework.

Review Request #15060 — Created May 15, 2026 and submitted May 19, 2026, 4:26 p.m.

Information

Owner

chipx86

Repository

Review Board

Branch

release-8.x

Bugs

Depends On

Reviewers

Groups

reviewboard

People

Description

This replaces the old action documentation, which was out of date with
the new changes in 8.0 and were constrained to the ActionHook page.

This will give us something that we can reference in the release notes,
give developers a solid starting point for writing actions, and give AI
agents enough information and links to assist others with that process.

Testing Done

Checked for spelling, link, and build errors.

Ran through Claude Code to check for any noticeable issues, including
inconsistency issues with the sample code or descriptions of attributes
and methods.

Commits

Summary	ID
Add a comprehensive guide on the actions framework. This adds a new page that covers how to customize the UI using the actions framework and action hooks. It walks through building a basic action, customizing it for different needs, introducing JavaScript support, custom rendering, and then how to use actions in the main places in which they're supported. This replaces the old action documentation, which was out of date with the new changes in 8.0 and were constrained to the `ActionHook` page. This will give us something that we can reference in the release notes, give developers a solid starting point for writing actions, and give AI agents enough information and links to assist others with that process.	ea81668f11d65770adfcf0782a469fbe3113b498

Summary

Add a comprehensive guide on the actions framework.

This adds a new page that covers how to customize the UI using the actions framework and action hooks. It walks through building a basic action, customizing it for different needs, introducing JavaScript support, custom rendering, and then how to use actions in the main places in which they're supported. This replaces the old action documentation, which was out of date with the new changes in 8.0 and were constrained to the `ActionHook` page. This will give us something that we can reference in the release notes, give developers a solid starting point for writing actions, and give AI agents enough information and links to assist others with that process.

ea81668f11d65770adfcf0782a469fbe3113b498

Issues

Description	From	Last Updated
Let's add a const myExtraState = this.get('myExtraState'); in here and the Spina example for good measure.	maubin	May 15, 2026, 2:18 a.m.
Let's add "This will place a menu in the header area (where your account menu lives)." here too. Even though …	maubin	May 15, 2026, 2:19 a.m.
We could say something like "This needs to be done to actually allow actions to be used"? Just something to …	maubin	May 15, 2026, 2:20 a.m.
This should say "Adding to built-in header menus".	maubin	May 15, 2026, 2:20 a.m.
This should say "Adding to built-in review request menus".	maubin	May 15, 2026, 2:20 a.m.
I think "review request action bar" is probably better here.	maubin	May 15, 2026, 2:20 a.m.
I like the writing in the header menu section better, I like how we say: "... by including the menu's …	maubin	May 15, 2026, 2:21 a.m.
Can we say here that if this is not specified, it will render on all pages that contain the attachment …	david	May 15, 2026, 4:30 p.m.
This is missing required items like action_id. Could either add those or use ... like you do in some of …	david	May 15, 2026, 4:31 p.m.
This reads a little bit weird, especially since the example is down lower. Can we move the example above the …	david	May 15, 2026, 4:32 p.m.
Should we also mention REVIEW_REQUEST_LEFT?	david	May 15, 2026, 4:33 p.m.
Most other places that you're listing action IDs they use double quotes.	david	May 15, 2026, 4:33 p.m.
Shouldn't this just be "actions"? (alternatively, move the file into the extensions directory).	david	May 15, 2026, 4:28 p.m.

flake8 passed.

JSHint passed.

Change Summary:

Added some page anchors.

Commits:

	Summary	ID
	Add a comprehensive guide on the actions framework. This adds a new page that covers how to customize the UI using the actions framework and action hooks. It walks through building a basic action, customizing it for different needs, introducing JavaScript support, custom rendering, and then how to use actions in the main places in which they're supported. This replaces the old action documentation, which was out of date with the new changes in 8.0 and were constrained to the `ActionHook` page. This will give us something that we can reference in the release notes, give developers a solid starting point for writing actions, and give AI agents enough information and links to assist others with that process.	be87287c9e8622fa1300b23290470a1f47fdaa8e
	Add a comprehensive guide on the actions framework. This adds a new page that covers how to customize the UI using the actions framework and action hooks. It walks through building a basic action, customizing it for different needs, introducing JavaScript support, custom rendering, and then how to use actions in the main places in which they're supported. This replaces the old action documentation, which was out of date with the new changes in 8.0 and were constrained to the `ActionHook` page. This will give us something that we can reference in the release notes, give developers a solid starting point for writing actions, and give AI agents enough information and links to assist others with that process.	9b5fa4b84394ca9a1e95d18f4376ed0bf410d0ab

Diff:

Revision 2 (+1952 -328)

Show changes

	docs/manual/extending/actions.rst
	docs/manual/extending/index.rst
	docs/manual/extending/extensions/hooks/action-hooks.rst

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

```
Nice, very informative.
```

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

The issue has been resolved. Show all issues

Let's add a const myExtraState = this.get('myExtraState'); in here and the Spina example for good measure.

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

The issue has been resolved. Show all issues

Let's add "This will place a menu in the header area (where your account menu lives)." here too. Even though we already say that in the general action docs above, it'd be useful here if someone just skips to this section without reading the other stuff.

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

The issue has been resolved. Show all issues

We could say something like "This needs to be done to actually allow actions to be used"? Just something to stress that this needs to be done, for people who aren't familiar with registering and what it means I guess.

docs/manual/extending/actions.rst (Diff revision 2)
The issue has been resolved. Show all issues
```
This should say "Adding to built-in header menus".
```
docs/manual/extending/actions.rst (Diff revision 2)
The issue has been resolved. Show all issues
```
This should say "Adding to built-in review request menus".
```
docs/manual/extending/actions.rst (Diff revision 2)
The issue has been resolved. Show all issues
```
I think "review request action bar" is probably better here.
```

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

The issue has been resolved. Show all issues

I like the writing in the header menu section better, I like how we say:

"... by including the menu's
action ID as the placement's parent_id.

The following action IDs are available:"

Change Summary:


Added a this.get('...') example to both the JavaScript and TypeScript docs.
Improved some wording and made it more consistent between sections.
Expanded the titles for some subsections.

Commits:

	Summary	ID
	Add a comprehensive guide on the actions framework. This adds a new page that covers how to customize the UI using the actions framework and action hooks. It walks through building a basic action, customizing it for different needs, introducing JavaScript support, custom rendering, and then how to use actions in the main places in which they're supported. This replaces the old action documentation, which was out of date with the new changes in 8.0 and were constrained to the `ActionHook` page. This will give us something that we can reference in the release notes, give developers a solid starting point for writing actions, and give AI agents enough information and links to assist others with that process.	9b5fa4b84394ca9a1e95d18f4376ed0bf410d0ab
	Add a comprehensive guide on the actions framework. This adds a new page that covers how to customize the UI using the actions framework and action hooks. It walks through building a basic action, customizing it for different needs, introducing JavaScript support, custom rendering, and then how to use actions in the main places in which they're supported. This replaces the old action documentation, which was out of date with the new changes in 8.0 and were constrained to the `ActionHook` page. This will give us something that we can reference in the release notes, give developers a solid starting point for writing actions, and give AI agents enough information and links to assist others with that process.	5a65068f9b4749f95c9b7ed5db976d09beccae77

Diff:

Revision 3 (+1968 -328)

Show changes

	docs/manual/extending/actions.rst
	docs/manual/extending/index.rst
	docs/manual/extending/extensions/hooks/action-hooks.rst

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

```
Ship It!
```

docs/manual/extending/actions.rst (Diff revision 3)

The issue has been resolved. Show all issues

Can we say here that if this is not specified, it will render on all pages that contain the attachment point?

docs/manual/extending/actions.rst (Diff revision 3)

The issue has been resolved. Show all issues

This is missing required items like action_id. Could either add those or use ... like you do in some of the other examples.

docs/manual/extending/actions.rst (Diff revision 3)

The issue has been resolved. Show all issues

This reads a little bit weird, especially since the example is down lower.

Can we move the example above the variable list?

chipx86

May 15, 2026, 4:37 p.m.

I was jumping around too much writing this.

docs/manual/extending/actions.rst (Diff revision 3)
The issue has been resolved. Show all issues
```
Should we also mention REVIEW_REQUEST_LEFT?
```
docs/manual/extending/actions.rst (Diff revision 3)
The issue has been resolved. Show all issues
```
Most other places that you're listing action IDs they use double quotes.
```

docs/manual/extending/index.rst (Diff revision 3)

The issue has been resolved. Show all issues

Shouldn't this just be "actions"? (alternatively, move the file into the extensions directory).

chipx86

May 15, 2026, 4:37 p.m.

Huh, extensions/actions is where I thought I had it. Fixing.

Change Summary:


Clarified apply_to's behavior when empty.
Added a missing ... to an action example.
Fixed up the order and wording around a sample template.
Fixed a case of action IDs that were using single instead of double quotes.
Fixed the location of the file.

Commits:

	Summary	ID
	Add a comprehensive guide on the actions framework. This adds a new page that covers how to customize the UI using the actions framework and action hooks. It walks through building a basic action, customizing it for different needs, introducing JavaScript support, custom rendering, and then how to use actions in the main places in which they're supported. This replaces the old action documentation, which was out of date with the new changes in 8.0 and were constrained to the `ActionHook` page. This will give us something that we can reference in the release notes, give developers a solid starting point for writing actions, and give AI agents enough information and links to assist others with that process.	5a65068f9b4749f95c9b7ed5db976d09beccae77
	Add a comprehensive guide on the actions framework. This adds a new page that covers how to customize the UI using the actions framework and action hooks. It walks through building a basic action, customizing it for different needs, introducing JavaScript support, custom rendering, and then how to use actions in the main places in which they're supported. This replaces the old action documentation, which was out of date with the new changes in 8.0 and were constrained to the `ActionHook` page. This will give us something that we can reference in the release notes, give developers a solid starting point for writing actions, and give AI agents enough information and links to assist others with that process.	ea81668f11d65770adfcf0782a469fbe3113b498

Diff:

Revision 4 (+1986 -328)

Show changes

	docs/manual/extending/index.rst
	docs/manual/extending/extensions/actions.rst
	docs/manual/extending/extensions/hooks/action-hooks.rst

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

```
Ship It!
```

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