docs: focus Getting Started on npm flows - #64
Merged
Conversation
Adds .claude/skills/docs-review with a review workflow (SKILL.md) and a distilled rubric (references/docs-tips.md) sourced from the '50 docs tips' series at rainsberger.ca, for reviewing documentation files, pasted text, or web pages and returning structured, actionable feedback. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Tm5NNentgCzyXdpirF1Zfm
Getting Started reworked per docs-review findings:
- Quick start now ends with the reader seeing the component render
(cd / npm install / npm run dev + expected outcome) and states its
prerequisites up front
- CDN section removed in favor of the npm flows; a tip links to the
CodePen examples for build-step-free setups
- npm section shows the bare-specifier import and links onward to Usage
- support links moved out of Installation into a Getting help section
- redundant intro sentence dropped
Also fixes the CDN import URLs on the other guide pages: the published
package ships only dist/ ("files": ["dist"]), so unpkg paths like
web-component-base@latest/index.js resolve to nothing; point them at
dist/ instead.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Tm5NNentgCzyXdpirF1Zfm
✅ Deploy Preview for demo-wcb ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
✅ Deploy Preview for web-component-io ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
esm.sh resolves the package exports map, so imports use the bare package name and subpaths (web-component-base@latest, /html, /utils) instead of dist/ file paths — matching what the CodePen examples use. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Tm5NNentgCzyXdpirF1Zfm
"No build step?" implied the npm flows require one; wcb doesn't need a build step — the scaffold's TypeScript is a nice-to-have, not a requirement. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Tm5NNentgCzyXdpirF1Zfm
ayo-run
changed the title
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
2 participants
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.
Update getting started