docs: refresh READMEs for v8#1479
Merged
Merged
Conversation
Root README:
- Add the brand lockup via <picture>, light/dark aware; swap the hero to
demo-hero.webp
- Consolidate the badge row onto shields.io and centre it (one row, 632px)
- Fix the Quick Start: `className` is not the theming API, use `theme={themeDark}`
- Fix the broken ./LICENSE link and state the multi-licence split
- List dockview-enterprise in the packages table
- Correct the React (16.8-19) and Angular (>=21.0.6) peer ranges
- Drop build-tool detail (NX, Biome) and the build-order diagram; AGENTS.md
already documents these for contributors
- Fix the #Provenance anchor
Published package READMEs:
- Add the lockup and demo-hero, consolidate badges onto shields.io
- Fix theming to the `theme` property across every binding
- Fix the Angular example: DockviewAngularModule (not DockviewModule) and
<dv-dockview> (not <dockview-angular>)
- Reframe dockview-core as an internal package that redirects to dockview
- dockview-enterprise: lockup, badges, and a commercial licence note
AGENTS.md:
- Document the public-documentation conventions: dockview-core is internal,
the module system is internal, don't enumerate enterprise features, don't
document the unlicensed behaviour
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
|
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
1 participant
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.
Refreshes the root README and all six published package READMEs for v8. Started as a logo/image swap and turned up a number of real bugs along the way.
Bugs fixed
The Quick Start theming didn't work.
classNameis a realDockviewOptionsfield, so it type-checks, but it isn't the theming API —updateTheme()readsthis._options.theme ?? themeAbyssand applies that to the shell. The docs settle it (theming.mdx): "For dock components pass the theme object to thethemeproperty. For other components such as split, pane, and grid views, set the theme's associated CSS class on theclassNameproperty." Every README now passesthemeand this was wrong in all six.The Angular example wouldn't compile. It imported
DockviewModule(the real export isDockviewAngularModule) and used<dockview-angular>(the selector isdv-dockview). Both now match the source and thetemplates/dockview/*/angularexamples.The licence link was broken.
[LICENSE](./LICENSE)404s — the file isLICENCE.md. The section also claimed a flat "MIT", which is no longer true.The provenance anchor was wrong in the root README (
#user-content-provenance);#Provenanceis the working form, confirmed manually.Peer ranges were overstated: React is
^16.8 || ^17 || ^18 || ^19(not open-ended>=16.8), Angular is>=21.0.6. Plus the long-standing "Security at mind" typo.Presentation
<picture>, light/dark aware, sourced from the brand kit as SVG (2.8KB vs 33KB PNG, no font dependency). Verified the swap works on GitHub —themed-picturehandles it even though GitHub injects an<a>inside the<picture>.demo-hero.webp.Positioning
dockview-corereframed as an internal package that redirects todockview— it previously marketed itself with badges and install instructions on its own npm page.dockview-enterpriselisted in the packages table, with lockup, badges and a commercial licence note. No bundle size badge: bundlephobia 429s on the0.0.0placeholder and the badge renders as an error string.Public Documentationsection recording the conventions applied here.Before publishing v8
None need code changes, but all three are gated on this merging to
masterfirst:blob/HEAD, so the two lockups anddemo-hero.webpmust be onmasteror the images 404 on the npm pages.[licensing](https://dockview.dev/docs/overview/features)404s until the v8 docs deploy (features.mdxis v8-branch only).dockview-enterprisestill showsv0.0.0on npm until a real version publishes.🤖 Generated with Claude Code