Skip to content

[Mate][Docs] Split the component docs into a getting-started page and reference pages - #2568

Merged
chr-hertel merged 1 commit into
symfony:mainfrom
wachterjohannes:docs/mate-restructure
Sep 22, 2026
Merged

chr-hertel merged 1 commit into
symfony:mainfrom
wachterjohannes:docs/mate-restructure

Conversation

@wachterjohannes

Copy link
Copy Markdown
Member
Q A
Bug fix? no
New feature? no
Docs? yes
Issues
License MIT

mate.rst mixed onboarding with the extension, skills and command reference. The interpreter choice was explained twice with contradicting details, the extension toggle five times, and troubleshooting was spread over four pages.

The index is now the getting-started page. New pages mate/extensions.rst, mate/skills.rst and mate/commands.rst hold the reference, and every topic has one home. The Symfony and Monolog packages are called extensions throughout, matching their package names, and community extensions point to MatesOfMate and awesome-mate. The pages also cover what the code offers but the docs missed: the untrusted_data envelope, all symfony-profiler-list filters, all eight collector formatters, undocumented command options, env file loading, and what mate init does without interaction.

Depends on #2553 and #2554: the text describes MATE_DEBUG_LOG_FILE and mate.env_file as they behave with those two fixes.

@chr-hertel chr-hertel left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Didn't review in detail - but structure looks good to me :)

@chr-hertel
chr-hertel force-pushed the docs/mate-restructure branch from 18d0f9d to ff28aa3 Compare September 22, 2026 22:46
@chr-hertel

Copy link
Copy Markdown
Member

Thank you @wachterjohannes.

@chr-hertel
chr-hertel merged commit 93ad528 into symfony:main Sep 22, 2026
11 checks passed
@wachterjohannes
wachterjohannes deleted the docs/mate-restructure branch September 23, 2026 03:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Mate Issues & PRs about the AI Mate component Status: Reviewed

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants