sentry-docs icon indicating copy to clipboard operation
sentry-docs copied to clipboard

Develop docs 2

Open a-hariti opened this issue 1 year ago • 4 comments

Platforms changes for developer docs

cutoff point

Author: Alberto Leal <[email protected]>
Date:   Thu Jun 27 16:34:50 2024 -0400

    fix: Update docs on running migration tests (#1323)

Introduces two npm scripts for developer docs:

  1. Dev
 yarn dev:developer-docs 
  1. Build
yarn build:developer-docs

TODO:

  • [x] port <JsonSchema /> component and its logic
  • [x] add data-schemas submodule dependency
  • [x] port Dependabot logic to update it automatically
  • [x] sidebar nesting
  • [x] home page
  • [x] sitemap
  • [ ] revert build npm script to build sdk docs and use build:developer-docs instead
  • [x] limit vercel.json redirects to hostname
    • [x] account for preview subdomains
    • [x] port latest redirects fromvercel.json on master
  • [x] fix breadcrums
  • [x] fix Github CTA
  • [ ] Algolia search for developer docs
  • [ ] add a blip of context to:
    • develop-docs/backend/index.mdx
    • develop-docs/services/index.mdx

a-hariti avatar Jun 10 '24 20:06 a-hariti

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

Name Status Preview Comments Updated (UTC)
sentry-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jul 11, 2024 1:11pm
1 Skipped Deployment
Name Status Preview Comments Updated (UTC)
develop-docs ⬜️ Ignored (Inspect) Visit Preview Jul 11, 2024 1:11pm

vercel[bot] avatar Jun 10 '24 20:06 vercel[bot]

Bundle Report

Changes will increase total bundle size by 971.29kB :arrow_up:

Bundle name Size Change
sentry-docs-server 9.25MB 960.28kB :arrow_up:
sentry-docs-client 7.88MB 8.28kB :arrow_up:
sentry-docs-edge-server 252.86kB 2.73kB :arrow_up:

codecov[bot] avatar Jun 10 '24 20:06 codecov[bot]

Don't know if this would be part of the sidebar nesting task, but I noticed, the "API" page shows up twice in the sidebar. It's probably not the only page

Screenshot 2024-06-25 at 10 49 48

stephanie-anderson avatar Jun 25 '24 08:06 stephanie-anderson

that Application section is built manually, so shouldn't be an issue once we get rid of those @stephanie-anderson

a-hariti avatar Jun 25 '24 08:06 a-hariti