statusboard
statusboard copied to clipboard
feat(docs): Improve `docs.npmjs.com`
Summary
Make improvements to docs.npmjs.com
to allow it to be maintainable.
Exit Criteria
- [ ] add
npm query
inline demo- [ ] Create browser friendly bundle of arborist/query-selector-all
- [ ] Use
react-live
component fromprimer/doctocat
to run bundled query code - [ ] Create ~3-5 predefined arborist trees to query against
- [ ] Use
primer/doctocat
upstream docs themeTODO: add tracking PR
- [x] Update dependencies
- [x] Make + test changes (theme, config, components) needed to use
primer/doctocat
- [ ] Make PR to
primer/doctocat
with upstream changes needed - [ ] Install
primer/doctocat
and use Gatsby theme shadowing for any needed changes innpm/documentation
- [ ] Deprecate/archive
npm/doctornpm
- [ ] Update
npm/cli
+npm/documentation
build process- https://github.com/npm/cli/pull/5309
- [x] Remove duplicate work being done in both repos
- [x] Remove generated content from source in
npm/cli
- [x] Install cli as
dependencies
innpm/documentation
- [ ] Build docs daily + workflow_dispatch from
npm/cli
- [ ] Allow
npm/cli
to have workspaces with non-bundled production deps
Stretch Goals
- [ ] Upate to mdx v2 with breaking content changes
- [x] Leverage PR preview deployments for GitHub Pages
- https://github.com/npm/documentation/pull/168
- https://github.com/npm/documentation/pull/170
- https://github.com/npm/documentation/pull/171
- https://github.com/npm/documentation/pull/173
- [x] Archive
docs-staging
repo https://github.com/github/npm-cli/issues/108
- [ ] investigate leveraging Gatsby's existing cache for builds