Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat(docs): Improve docs.npmjs.com - v2 #603

Closed
6 of 10 tasks
darcyclarke opened this issue Nov 7, 2022 · 1 comment
Closed
6 of 10 tasks

feat(docs): Improve docs.npmjs.com - v2 #603

darcyclarke opened this issue Nov 7, 2022 · 1 comment
Labels
feature

Comments

@darcyclarke
Copy link
Contributor

darcyclarke commented Nov 7, 2022 •
edited by lukekarrys

Summary

Make improvements to docs.npmjs.com to allow it to be maintainable. (carried over from #526)

Exit Criteria

  • add CONTRIBUTING.md - outlining who is responsible for reviewing PRs vs. style/theme updates (only one team should own this)
  • add npm query inline demo
    • Create browser friendly bundle of arborist/query-selector-all
    • Use react-live component from primer/doctocat to run bundled query code
    • Create ~3-5 predefined arborist trees to query against
  • Use primer/doctocat upstream docs theme TODO: add tracking PR
    • Make PR to primer/doctocat with upstream changes needed
    • Install primer/doctocat and use Gatsby theme shadowing for any needed changes in npm/documentation
  • Upate to mdx v2 with breaking content changes
  • investigate leveraging Gatsby's existing cache for builds
@darcyclarke darcyclarke assigned lukekarrys and unassigned lukekarrys Nov 7, 2022
@lukekarrys
Copy link
Contributor

Closing this since it is all complete outside of the query demo which is no longer happening.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
feature
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@darcyclarke @lukekarrys