Problem/Motivation

The module has a README aimed at developers and a project page aimed at evaluators, and nothing in between. Site builders and administrators have nowhere to read how to create a mode, what each field on the form does, where the dropdown can sit, or why the dropdown is sometimes not there at all.

Several behaviours are deliberate but look like faults, and none of them are written down anywhere a user would look:

  • Both browser-rendered chat surfaces hide the dropdown when the only option would be "All, let the assistant decide", so a site with no saved modes shows no dropdown.
  • In the "In the toolbar (compact)" placement the control is tied to the send button, which Drupal Canvas AI keeps hidden until there is something to send, so an empty message box shows nothing.
  • The Modes listing reads "Prompt only" for a mode that steers by its system prompt addition alone, and "None" only for a mode that steers nothing. The difference matters and is not explained.
  • A mode never removes tools from the assistant. It only adds a steering instruction, which is reassuring to know and is currently undocumented.

Steps to reproduce

Not applicable. This is a documentation addition.

Proposed resolution

Add a docs/ folder to 1.0.x with one page per audience:

  • docs/README.md: what the module does and an index of the pages.
  • docs/choosing-a-mode.md: for anyone using the assistant.
  • docs/managing-modes.md: for site administrators, covering the form fields, the four placements and the permission.
  • docs/developing-with-modes.md: the config entity, shipping modes in config or a recipe, the block and render element, the options endpoint and how steering works.
  • docs/troubleshooting.md: the behaviours above that look like faults and are not.

Add two screenshots under docs/images/, a short Documentation pointer near the top of README.md, and links to the docs from the project page.

Remaining tasks

  • ✅ File an issue
  • ✅ Addition, change, update or fix
  • ✅ Documentation
  • ❌ Reviewed by a human
  • ❌ Code review by maintainers

User interface changes

None in the module. The project page gains links to the documentation.

API changes

None.

Data model changes

None.

Release notes snippet

Adds a documentation folder covering the module for site builders, administrators and developers, including a troubleshooting page for the behaviours that look like faults and are not.

Command icon Show commands

Start within a Git clone of the project using the version control instructions.

Or, if you do not have SSH keys set up on git.drupalcode.org:

Comments

rajab natshah created an issue. See original summary.

rajab natshah’s picture

StatusFileSize
new137.77 KB
new114.67 KB
new76.77 KB

Fresh screenshots taken on a Varbase 11 site running 1.0.0-alpha2, so they show the current wording rather than the pre-release one.

- 3-mode-list-open.png: the Mode list in the Drupal Canvas AI panel, with the default option reading "All, let the assistant decide". The em dash is gone as of #3613457.
- 1-modes-listing-prompt-only.png: the Modes listing, with three modes reading "Prompt only" because they steer through a system prompt addition and name no sub-agents. Before #3613457 those rows read "None", which looked as if the modes did nothing.
- 2-settings-placements.png: the settings tab with the four dropdown placements.

The list is the real select element expanded in place. A native dropdown popup is drawn by the operating system outside the page, so it cannot appear in a screenshot. The options, their order and the selection are live from the module.

  • rajab natshah committed 7c21f89d on 1.0.x
    docs: #3613484 Add a docs folder for site builders, administrators and...

  • rajab natshah committed 66278bf3 on 1.0.x
    fix: #3613484 Publish the documentation with mkdocs and unblock apt in...

  • rajab natshah committed 13da4bc3 on 1.0.x
    docs: #3613484 Show the Mode dropdown at the top of the documentation...
rajab natshah’s picture

Assigned: Unassigned » josebc
Status: Active » Needs review
Issue tags: +ai_agent_modes-1.0.0-alpha3
rajab natshah’s picture

Assigned: josebc » mohammed j. razem
rajab natshah’s picture

Assigned: mohammed j. razem » Unassigned
Status: Needs review » Fixed

Now that this issue is closed, review the contribution record.

As a contributor, attribute any organization that helped you, or if you volunteered your own time.

Maintainers, credit people who helped resolve this issue.

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.