Repository navigation
Docs: Bring the README up to date with the code - #1043
Merged
Merged
Conversation
The Gutenberg drop receiver shipped in #260/#261, but "Still ahead" still listed Media to Gutenberg block insertion as the North Star. Describe it under Current State and keep only the remaining drag work (pluggable mime-type negotiation, a Site Editor receiver). Also drop items that are done or superseded: View Transitions already drive the dock reveal, dock peek and phone app open; the admin colour scheme was replaced by palette tokens and desktop themes, now listed under Current State; tablet already gets the bottom dock. The AI assistant bullet now names the WordPress AI Client and abilities instead of an OpenAI key. docs/architecture.md carried the same list.
- Name the dock's auto-hide by its Preferences label (Dynamic). - Note the AI assistant needs WordPress 7.0+, and list tool filters instead of the removed post-type filter. - Component count is ~70, not ~25. - Repository layout: ai-copilot, settings/ and plugins/ describe what those directories hold now; the Posts window builds as an App Framework client view under assets/js/apps/. - Bundled extensions: list Electron Adapter and OpenStation Beta, and mention extensions/mio-js/ beside extensions/base/. - architecture.md: variables.css holds the palette tokens, and the shipped list names drag & drop into Gutenberg.
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 it does
The README's
## Still aheadsection (and the matching "Coming up" list indocs/architecture.md) now lists only work the code doesn't do yet. The shipped parts are described under## Current State. Other stale claims in both files are corrected too: the component count, the repository layout, the build outputs and the bundled extensions.Rationale
"Still ahead" still listed Media to Gutenberg block insertion as the North Star, but
src/gutenberg-drop-receiver.tsshipped in #260/#261. Other bullets had drifted the same way. Each one was checked against the code:core/image/core/video/core/audio/core/fileor a linked paragraph, at Gutenberg's own insertion lineopenstation_drag_*filters are only planned) and a Site Editor receiverdocs/mobile.mdwp.os.modereportstablet; a tablet gets the desktop, whose default dock is already at the bottomsrc/dock-behavior.ts), dock peek and phone app open--os-*tokens plus desktop themes replaced it (see the note invariables.css)The "pass on real devices" item was dropped to match the "Not yet" list in
docs/mobile.md.Implementation
Docs only. Besides the "Still ahead" bullets,
## Current State:docs/bridge-protocol.md;docs/desktop-themes.md;<os-*>components (68 insrc/ui/components/), not ~25;The rest of the README:
includes/ai-copilot/,src/settings/andsrc/plugins/describe what they hold now (the Preferences window itself isapps/os-settings/).posts-window.jsentry becomesassets/js/apps/<name>.js, the App Framework client views built bynpm run build:apps, which is where the Posts window lives now.extensions/mio-js/besideextensions/base/as not installable on its own.In
docs/architecture.md,variables.cssis described as the palette tokens scoped tobody.os-active, and the "Shipped" paragraph names drag & drop into Gutenberg instead of the Media Library drag bridge.Testing instructions
Read the rendered
README.mdanddocs/architecture.mdon this branch. Drag & drop can be checked on a local wp-env: open a post in the editor window, then drag an image from the Media Library or a My WordPress media tile into it. An image block should land at the blue insertion line.