Skip to content

Docs: Bring the README up to date with the code - #1043

Merged
epeicher merged 2 commits into
trunkfrom
docs/readme-still-ahead
Oct 23, 2026
Merged

epeicher merged 2 commits into
trunkfrom
docs/readme-still-ahead

Conversation

@epeicher

@epeicher epeicher commented Oct 23, 2026 •

Copy link
Copy Markdown
Collaborator

What it does

The README's ## Still ahead section (and the matching "Coming up" list in docs/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.ts shipped in #260/#261. Other bullets had drifted the same way. Each one was checked against the code:

Bullet In the code today Stays ahead
Cross-window drag & drop Media Library attachments and My WordPress media, post and user tiles drop into a post editor as core/image / core/video / core/audio / core/file or a linked paragraph, at Gutenberg's own insertion line Pluggable mime-type negotiation (the payload-to-block map is fixed; the openstation_drag_* filters are only planned) and a Site Editor receiver
Mobile Phone layer, per docs/mobile.md Pull-to-refresh
Tablet hybrid wp.os.mode reports tablet; a tablet gets the desktop, whose default dock is already at the bottom Split view and slide-over
Polish: View Transitions Used by the dock's auto-hide (src/dock-behavior.ts), dock peek and phone app open Nothing
Polish: colour-scheme variables Superseded on purpose: the admin colour scheme no longer tints the shell; --os-* tokens plus desktop themes replaced it (see the note in variables.css) Nothing
Polish: a11y audit One-off fixes only Full audit

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:

  • describes drag & drop into Gutenberg instead of only the bridge between frames, linking docs/bridge-protocol.md;
  • gains a "Design tokens & desktop themes" bullet, linking docs/desktop-themes.md;
  • mentions the dock's auto-hide, by its Preferences label (Dynamic);
  • describes the AI assistant as running on the WordPress AI Client (WordPress 7.0+), with credentials from Core's Connectors screen and read-only abilities as its tools, replacing the old "OpenAI loop, admin-configured API key" wording;
  • counts ~70 <os-*> components (68 in src/ui/components/), not ~25;
  • lists tool filters in the hook surface instead of the removed post-type filter.

The rest of the README:

  • The intro says "dock" instead of "left-edge dock", since the default placement is bottom.
  • Repository layout: includes/ai-copilot/, src/settings/ and src/plugins/ describe what they hold now (the Preferences window itself is apps/os-settings/).
  • Build outputs: the old posts-window.js entry becomes assets/js/apps/<name>.js, the App Framework client views built by npm run build:apps, which is where the Posts window lives now.
  • Bundled extensions: adds Electron Adapter and OpenStation Beta, and mentions extensions/mio-js/ beside extensions/base/ as not installable on its own.

In docs/architecture.md, variables.css is described as the palette tokens scoped to body.os-active, and the "Shipped" paragraph names drag & drop into Gutenberg instead of the Media Library drag bridge.

Testing instructions

Read the rendered README.md and docs/architecture.md on 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.

Open WordPress Playground Preview

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.
@epeicher epeicher changed the title Docs: Move shipped work out of the README's "Still ahead" Docs: Bring the README up to date with the code Oct 23, 2026
@epeicher
epeicher merged commit 4c5042a into trunk Oct 23, 2026
7 checks passed
@epeicher
epeicher deleted the docs/readme-still-ahead branch October 23, 2026 08:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant