sentry-docs
sentry-docs copied to clipboard
Develop docs 2
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:
- Dev
yarn dev:developer-docs
- Build
yarn build:developer-docs
TODO:
- [x] port
<JsonSchema />component and its logic - [x] add
data-schemassubmodule dependency - [x] port Dependabot logic to update it automatically
- [x] sidebar nesting
- [x] home page
- [x] sitemap
- [ ] revert
buildnpm script to build sdk docs and usebuild:developer-docsinstead - [x] limit
vercel.jsonredirects to hostname- [x] account for preview subdomains
- [x] port latest redirects from
vercel.jsonon 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
-
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 |
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: |
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
that Application section is built manually, so shouldn't be an issue once we get rid of those @stephanie-anderson