docs icon indicating copy to clipboard operation
docs copied to clipboard

v2 docs upgrade

Open ryanwaits opened this issue 1 year ago • 1 comments

What does this PR do?

...a lot

rollout plan

the timing is a little confusing at the moment around docs migration, so here is the current rollout plan for migrating to docs v2

  • content complete by the end by 5/31 (this does not mean deployed)
  • 6/1 will start the full on reviews (this includes design), this may take a couple weeks to integrate any feedback or updates that come out of that
  • during the review process, there may be some additional features that need to be integrated (such as search or new guides section) that will be worked on, as well as handling edge cases like broken links and dev ops related changes

as soon as reviews and required features are ready, we can migrate - this could be as soon as early to mid june

existing issues getting addressed

  • [ ] ordinals api missing documentation: https://github.com/orgs/hirosystems/projects/50?pane=issue&itemId=48737431
  • [ ] normalize api response documentation: https://github.com/orgs/hirosystems/projects/50/views/1?pane=issue&itemId=51936867
  • [ ] add chainhook payload docs: https://github.com/hirosystems/docs/issues/644
  • [ ] document derivation path settings for deployments: https://github.com/hirosystems/docs/issues/632
  • [ ] add more context around the createAssetInfo section of pcs: https://github.com/hirosystems/docs/issues/625
  • [ ] update code snippet for using api key with stacks.js: https://github.com/hirosystems/docs/issues/625

upgraded content, by section

Stacks

  • [ ] stacks.js
    • [ ] api references
  • [ ] clarinet
    • [ ] clarinet sdk
    • [ ] api references
  • [ ] chainhook
  • [ ] platform
  • [ ] explorer
  • [ ] stacks api
  • [ ] token metadata api

Ordinals

  • [ ] ordhook
  • [ ] explorer
  • [ ] ordinals api

new stuff

  • [ ] landing page
  • [ ] dedicated guides page
  • [ ] search

ryanwaits avatar Apr 11 '24 18:04 ryanwaits

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
docs-v2 ✅ Ready (Inspect) Visit Preview 💬 25 unresolved
✅ 170 resolved
Jun 28, 2024 2:45pm
hiro-systems-docs ❌ Failed (Inspect) Jun 28, 2024 2:45pm

vercel[bot] avatar Apr 11 '24 18:04 vercel[bot]