[📖] [v2] the api docs use the wrong package names
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 22.1k
- Forks
- 1.4k
- Avg merge
- 1d 10h
- Merged PRs (30d)
- 52
Description
Suggestion
the package names on the v2 docs are the names of the directories. The detailed entries are not the actual package names, e.g. @qwik.dev/qwik instead of @qwik.dev/core. https://qwikdev-build-v2.qwik-8nx.pages.dev/api/
scripts/api-docs.ts on the build/v2 branch needs to be changed so that it has an extra translatation between the directory name and the package name.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with scripts/api-docs.ts on the build/v2 branch and compare its directory-to-package handling with the detailed API entries at the linked v2 docs. Add the needed translation so entries use actual package names, such as @qwik.dev/core rather than @qwik.dev/qwik. Verify the generated API documentation shows the corrected names.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation, tooling
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 62/100