Skip to content

Conversation

@fellyph
Copy link
Collaborator

@fellyph fellyph commented Nov 1, 2025

Removes kapa AI button from the Playground doc site – it triggers a React error here:

CleanShot 2025-11-03 at 11 07 10@2x

This is a temporary measure to fix the documentation page until the error is figured out—assuming we continue with Kapa AI (it's a free trial).

This PR also updates the Docusaurus version from 3.8.1 to 3.9.2. It doesn't seem strictly necessary but was a low-hanging fruit to co-locate with this PR.

Testing instructions

Build the doc site locally, confirm there's no error at /wordpress-playground/api/blueprints/interface/EnableMultisiteStep/#Index

@fellyph fellyph marked this pull request as ready for review November 1, 2025 10:54
@fellyph fellyph requested a review from a team as a code owner November 1, 2025 10:54
@adamziel adamziel changed the title [Docs] Update Docusaurus 3.9 [Docs] Remove kapa AI button Nov 1, 2025
@adamziel
Copy link
Collaborator

adamziel commented Nov 1, 2025

Do we need to update docusaurus while we’re disabling kapa ai? Also I don’t follow the description, e.g:

Added a markdown.hooks section to the Docusaurus config in docusaurus.config.js, moving the onBrokenMarkdownLinks: 'throw' setting under the new structure for improved clarity and future extensibility.

How does that improve clarity or extensibility?

Is it the GitHub „summarize changes” feature? I’ve noticed these automated descriptions are mostly noise. The „files changed” tab already tells us which files changed and how, duplicating that information in the description doesn’t add much and it distracts from the problem this PR solves.

The description is a form of documentation. We have all the context today, but in a few months we’ll forget. Or a new person will join who never had the context in the first place. Let’s spell out the obvious, explain design choices, and avoid merely rewriting the diff with words.

The description here could be just:

Removes the Kapa AI plugin — it crashes the current doc site with this error: (x). Also, it updates Docusaurus to 3.9.2 because: (y). The next step is (z).

It would answer the important question: what are we changing, why, and is it permanent. The AI won’t ever get that from the code.

@adamziel
Copy link
Collaborator

adamziel commented Nov 3, 2025

btw I don't see the error in the docs anymore – are we good? https://wordpress.github.io/wordpress-playground/blueprints/steps/#EnableMultisiteStep

@adamziel
Copy link
Collaborator

adamziel commented Nov 3, 2025

@adamziel adamziel added [Type] Documentation Improvements or additions to documentation [Type] Enhancement New feature or request labels Nov 3, 2025
@fellyph
Copy link
Collaborator Author

fellyph commented Nov 3, 2025

@adamziel, I can split into two different tasks. We need to check with the Kapa AI team if the tool is still available.

@adamziel adamziel merged commit d2d2da4 into trunk Nov 3, 2025
29 checks passed
@adamziel adamziel deleted the update-docusaurus-3-9 branch November 3, 2025 10:09
@adamziel
Copy link
Collaborator

adamziel commented Nov 3, 2025

@fellyph I've brushed up the description and merged. This seems like a good change, I was just confused by the description as I wasn't sure why we update Docusaurus—e.g. is something failing on the older version. It seems like an optional change that helps us without breaking other things so let's get it in.

@adamziel
Copy link
Collaborator

adamziel commented Nov 3, 2025

@fellyph
Copy link
Collaborator Author

fellyph commented Nov 3, 2025

Yes, I was thinking that was cache. On my tests on Saturday, it was working. I will pull back the button and do more investigation

@fellyph
Copy link
Collaborator Author

fellyph commented Nov 3, 2025

@adamziel I have created a new PR: #2858

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

[Type] Documentation Improvements or additions to documentation [Type] Enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants