Docs

Use executable docs actions

Use stable docs action ids to open the right UI from docs or Codex.

What executable docs actions are for

Executable docs actions are stable identifiers for UI destinations. Instead of only saying "open Settings, then Environment, then Secrets", a docs entry can also name settings.environment.secrets, and CoCalc can open that panel in the current browser session.

Use an action id

  1. Open a docs entry that lists an action.
  2. Click the action button, or ask Codex to use the action id.
  3. CoCalc opens the matching project UI when the action is implemented and available.
  4. If the action is not implemented yet, use the written steps.

Agents can list actions with cocalc browser action docs-list and execute one with cocalc browser action docs <action-id>. Parameterized actions accept --param key=value; project-host actions also accept --host-id <id>.

Verify actions

Docs actions should be tested with browser-session verification. The verifier does not only check that the action returned success; it also asserts that the expected visible UI appeared.

Why this matters in CoCalc

Executable docs turn documentation into a bridge between explanation and action. That is especially valuable for Codex: it can answer a question, open the right panel, and then continue working in the same project context.