Move README-referenced static assets to a root-level static/ dir#1497
Merged
Conversation
The published package READMEs (dockview, dockview-core, dockview-react, dockview-vue, dockview-angular, dockview-enterprise) embed brand and demo images via GitHub raw links that pointed deep into packages/docs/static/img/. That path is fragile: it lives inside the internal docs package and breaks if the docs site is restructured. Move the referenced assets (dockview-lockup-dark.svg, dockview-lockup-light.svg, demo-hero.webp) to a root-level static/img/ directory and update every README link (package READMEs use GitHub raw URLs, the root README uses relative paths) to point there. Docusaurus is configured with staticDirectories to also serve the root static/ dir, so the docs site continues to resolve /img/demo-hero.webp unchanged. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01XSp5iRUMcxwEoS2MeDL5rx
|
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.
Description
The published package READMEs embed brand and demo images via GitHub raw links that pointed deep into
packages/docs/static/img/. That path is fragile: it lives inside the internaldocspackage and breaks if the docs site is restructured.This moves the assets that READMEs actually reference into a root-level
static/img/directory and repoints every link there, so the README image links no longer depend on thedocspackage's internal layout.git mv, history preserved):dockview-lockup-dark.svg,dockview-lockup-light.svg,demo-hero.webp→static/img/.dockview,dockview-core,dockview-react,dockview-vue,dockview-angular, anddockview-enterpriseREADMEs (GitHub raw URLs), plus the rootREADME.md(relative paths).staticDirectories: ['static', '../../static']topackages/docs/docusaurus.config.jsso the docs site keeps servingdemo-hero.webpat/img/demo-hero.webpunchanged. The two lockups are README-only; onlydemo-hero.webpis consumed by the docs site (src/pages/index.tsx).Type of change
Affected packages
dockview-coredockview(vanilla JS)dockview-reactdockview-vuedockview-angulardocs(Also touches
dockview-enterprise, which is not listed in the template.)How to test
blob/HEAD/static/img/...), and the rootREADME.mdimages resolve via the new relative paths.yarn build(orstart) inpackages/docsand confirm the homepage hero (/img/demo-hero.webp) still loads.staticDirectoriesnow merges the docs-localstatic/with the repo rootstatic/; only the three moved files live at the root, so there are no filename collisions.Checklist
yarn lint:fixpassesyarn formatpassesnpm run genhas been run and generated files are up to dateyarn testpassesNote: docs are deliberately excluded from Prettier per
packages/docs/AGENTS.md; no generated files or tests are affected by this change.🤖 Generated with Claude Code
Generated by Claude Code