Conversation
The site had accumulated content about how the docs were built rather than how to extend the plugin: extractor and grep-discovery sections, self-referential verification claims, and roughly 550 secondary file:line citations threaded through prose and callouts. Reference sites dev.fluentcart.com and dev.fluentcommunity.co are concise and task-focused; this brings the same shape here without changing the design, structure, or navigation. Removed: - devdocs.md, an internal docs-audit artifact, and its srcExclude entry - Regenerating / extractor sections and npm run extract instructions - The window inventory on the JS API page, which catalogued non-API internals including Vite React-refresh stubs that only exist in dev builds, and an Underscore shim belonging to wp.media - Page-builder editor shim internals, which are not extension points - Git-commit archaeology for recovering a dropped table schema from a private repo history - Duplicated Pro-detection archaeology and lockfile-vs-manifest trivia Reduced: - Secondary citations, so each hook and route keeps one Source anchor - Callout density where a warning only restated adjacent prose - AnalyticsTracker flush mechanics down to the two facts that matter Rewritten: - changelog.md, which recorded corrections to the documentation itself, is now a plugin developer-surface changelog keyed by plugin version Traps that change what a reader writes are kept: inverted filter defaults, the nested verdict completion flag, posterSrc vs poster, the global zero-id pass on media_locked_message, and the PHP 7.4 floor. Published prose drops from 55,472 to 47,612 words. VitePress build passes, so every internal link and anchor still resolves.
autharif
approved these changes
Aug 12, 2026
autharif
left a comment
There was a problem hiding this comment.
Summary
The change looks ready to merge with no blocker-level findings.
Key changes:
reference/data-model.mdaccurately preserves the distinction between current persistence and legacy storage, including the migrated presets option and dropped play-resume tables.reference/data-model.mddocuments_fp_migration_original_blockswith its write, rollback, and cleanup lifecycle.
Confidence Score: 4/5
- Merge stance:
APPROVEwith no confirmed Critical or Important issues. - The documentation changes retain the important persistence shapes, migration lifecycle, and shared-state integrity constraints while trimming secondary citations.
Last reviewed commit: DOCS: Trim non-essential detail from the developer docs
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What does this PR do and why?
The developer docs had accumulated a lot of content about how the docs were built rather than how to extend the plugin — extractor and grep-discovery sections, self-referential verification claims ("verified against 1.3.0", "source-verified"), and roughly 550 secondary
file:linecitations threaded through prose and callouts. The reference sites we're aligning with, dev.fluentcart.com and dev.fluentcommunity.co, are concise and task-focused.This trims to that shape. No design, structure, or navigation change — same pages, same sidebar, same theme.
Published prose: 55,472 → 47,612 words (−14%), plus
devdocs.md(7,245 words) deleted.Paired free/pro PR: N/A — documentation repo only, no plugin code touched.
Key changes
devdocs.md— deleted. An internal docs-audit artifact (927 lines) that was already excluded from the built site; itssrcExcludeentry is removed from.vitepress/config.mjs.changelog.md— rewritten. It recorded corrections to the documentation itself ("the hook extractor under-reported the action surface by two"); it is now a plugin developer-surface changelog keyed by plugin version (1.3.0, 1.0.9, 1.0.7).js-api/index.md— removed the "Everything else onwindow" section, a 12-row inventory of things the page itself said were not API, including Vite React-refresh stubs ($RefreshReg$,__vite_plugin_react_preamble_installed__) that only exist in dev builds, andwindow._, an Underscore shim belonging towp.media. −27% on that page.reference/data-model.md— removed instructions to recover a dropped table's schema viagit show <sha>^:...against a private repo history, plus the migrator's internal call order.reference/blocks.md— removed the page-builder editor shim internals (internal block registration mechanics, not an extension point), keeping only the consequence:getBlockType()returns the shim's schema inside a builder canvas.hooks/reference.md,rest-api/index.md,getting-started/architecture.md— removed the "Regenerating" sections,npm run extractinstructions, and the "grep returns 12 actions and 72 filters — by design" explanation.Deliberately kept: the traps that change what a reader writes — inverted filter defaults (
media_discoverable,media_page_noindex,behavior_can_report), the nested$payload['verdict']['complete']flag,posterSrcvsposter, the global zero-id pass onmedia_locked_message, "don't discard$html— the unlock form is inside it", and the PHP 7.4 floor.How to test
Documentation-only change. No plugin code path is affected.
npm install && npm run build— passes. VitePress fails the build on dead internal links, so this confirms every cross-reference and heading anchor still resolves after the cuts.npm run devand spot-check the trimmed pages:/js-api/,/reference/data-model,/reference/blocks,/hooks/reference,/changelog..vitepress/config.mjsdiffers only by the removeddevdocs.mdsrcExcludeentry.Merge checklist
npm run buildis the gate and it passessrcExcludelinedevdocs.mdwas already excluded from it, so no published URL changeschangelog.mdrewritten as part of this changeChanges & review routing
.vitepress/config.mjssrcExcludeAnything the reviewer should know?
Two judgement calls worth a second opinion:
Citation depth. Each hook and route keeps its single Source:
file:lineanchor; the secondary refs sprinkled through prose and callouts are gone. The reference sites carry no citations at all — I stopped short of that so a reader can still verify a signature against their installed version.The three extending guides are still dense.
extending/behavior-handler.mdspends significant space on theBehaviorStatesix-key whitelist and the shared state row. I read those closely and kept them: getting either wrong means your handler silently re-fires on every ping, or wipes another handler's progress. That is the same depth FluentCart's custom-payment-gateway tutorial runs at. Happy to thin them further if you disagree.Base branch note: the
fluentplayer-create-prskill's table specifiesdevas the base forfluent-player-devandfluent-player-pro. This docs repo differs —origin/HEADpoints atmain, and PRs #1 and #3 both merged tomain. Targetingmainaccordingly.