Right now there are only 2 ways of showing the user of an extension how he/she can configure the command(s).

1. Built the docs directly into the command

This can be done via the Detail component.

Pros

• The user can see this directly in Raycast which helps the user

Cons

• The extension developer needs to add this to all the commands in an extension
• The preference require property needs to be false, otherwise the user would not see the Detail help component
• The user don't see this in the intro page for require preferences

2. Add a README.md file to the extension repo

This is what most developers do.

Pros

• Easy to manage for the developer
• Can use html stuff too

Cons

• This is hard for the user which just use the store to install an extension

Proposal

There are multiple ways to tackle this problem. The following ones are my personal favorites.

1. Add a help action to the command and open it in the browser

This action would open the README.md file in the browser.

Pro

• Easy to impl. on Raycast side

Cons

• Not the Raycast-way of doing things because it involve the browser. UX is also not the best of course.
• Beginners needs to know that this help action exists (the link can also be provided in the initial setup dialog)

2. Add a help action to the command and show content in Raycast

This is how many applications do it like e.g. VSCode.

Pros

• Directly in raycast
• Could also be shown easily in the intro page of a command when no required preferences are set. So it is very user friendly
• Could also be copied into the final extension page for offline use or maybe use it also on raycast.com

Cons

• Markdown only, which could be a limiter. But this is not a hard limit.

Describe the feature and the current behavior/state.

Will this change the current api? How?
No.

Who will benefit with this feature?
Raycast users and extension developers.

Any Other info.