Skip to content

docs: fix heading formatting in commands.md and phrasing in tools-api.md #20679

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
g-samroberts merged 4 commits into from
Mar 9, 2026
Merged

docs: fix heading formatting in commands.md and phrasing in tools-api.md #20679

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
7bdb25b
docs: fix heading formatting in commands.md and refine phrasing in to…
campox747 Feb 28, 2026
f9f91b3
Update commands.md
campox747 Mar 6, 2026
6ed3c87
Update tools-api.md
campox747 Mar 7, 2026
ca3f623
Merge branch 'main' into fix-reference-docs
g-samroberts Mar 9, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 2 additions & 4 deletions docs/reference/commands.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,6 @@ with a forward slash (`/`), an at symbol (`@`), or an exclamation mark (`!`).

Slash commands provide meta-level control over the CLI itself.

### Built-in Commands
Copy link
Copy Markdown
Contributor

@g-samroberts g-samroberts Mar 6, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please don't remove.

Copy link
Copy Markdown
Contributor Author

@campox747 campox747 Mar 6, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok added it back.


### `/about`

- **Description:** Show version info. Share this information when filing issues.
Expand Down Expand Up @@ -61,9 +59,9 @@ Slash commands provide meta-level control over the CLI itself.
modifications, see the
[Checkpointing documentation](../cli/checkpointing.md).
- **`share [filename]`**
- **Description** Writes the current conversation to a provided Markdown or
- **Description:** Writes the current conversation to a provided Markdown or
JSON file. If no filename is provided, then the CLI will generate one.
- **Usage** `/chat share file.md` or `/chat share file.json`.
- **Usage:** `/chat share file.md` or `/chat share file.json`.

### `/clear`

Expand Down
4 changes: 2 additions & 2 deletions docs/reference/tools-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,8 +110,8 @@ its specific functionality.
## Extending with custom tools

While direct programmatic registration of new tools by users isn't explicitly
detailed as a primary workflow in the provided files for typical end-users, the
architecture supports extension through:
detailed as a primary workflow in this documentation, the architecture supports
Copy link
Copy Markdown
Contributor

@g-samroberts g-samroberts Mar 7, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think there's a conflict here as this section no longer exists. you can undo this change and it should resolve the conflict.

extension through:

- **Command-based discovery:** Advanced users or project administrators can
define a `tools.discoveryCommand` in `settings.json`. This command, when run
Expand Down