Clean up schemas and type definitions
Maintainers usually reply within 1 day
Nobody has claimed this yet.
- #527 by @Lms24 — closed without merging
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 48/100
- Issue type
- Refactor
- Clarity
- Mostly clear
- Activity status
- Quiet
- Tech stack
- typescript
- Domain
- documentation, tooling
Research direction
Compare the definitions in /schemas, docs/src/content.config.ts, and scripts/types.ts, including how the code generation script consumes its types. Decide whether one definition can serve all three uses or how synchronization should work; done means the current divergence risk is addressed across these locations.
Written by the indexing model from the issue text.
Description
Seems like we have three type/schema definitions at the moment:
/schemaswith JSON schema/docs/src/content.config.tsfor the Astro docs usingastro/zodfor validation/scripts/types.tsfor the code generation script
It would be nice if we could unify these or at least keep them better in sync. Definitely opens up room for divergence at the moment.
If we could use zod for code generation we can likely eliminate some type casts.
h/t @nsdeschenes for raising!
- Dominant language
- TypeScript
- Stars
- 16
- Forks
- 7
- Avg merge
- 2d 9h
- Merged PRs (30d)
- 63
Getting set up
- No Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from getsentry/sentry-conventions
-
Difficulty 2/5 1-3 hours Newbie friendliness 66/100
getsentry/sentry-conventions#732 · 1 comment ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 61/100
getsentry/sentry-conventions#731 · 1 comment ·
Maintainers usually reply within 1 day
-
Difficulty 3/5 1-2 days Newbie friendliness 58/100
getsentry/sentry-conventions#730 · 1 comment ·
Maintainers usually reply within 1 day
-
Difficulty 3/5 1-2 days Newbie friendliness 50/100
getsentry/sentry-conventions#709 · 1 comment ·
Maintainers usually reply within 1 day
-
Span SpecificationsOpen
Difficulty 5/5 Over a week Newbie friendliness 35/100
getsentry/sentry-conventions#659 · 1 comment ·
Maintainers usually reply within 1 day
All issues in getsentry/sentry-conventions
Similar issues
-
createAI: the ai peer range allows ai@6, which the provider cannot work withPossibly taken @akhil9tiet claimed this today. Openbug
Difficulty 1/5 Under an hour Newbie friendliness 83/100
cloudflare/agents#2690 · 3 comments ·
Maintainers usually reply within 1 day
-
[fullsend] E2E: theme — global-header ignores app.branding.fullLogo (RHDHBUGS-3670)Possibly taken @fullsend-ai-coder claimed this today. Opene2e-failure ready-to-code
Difficulty 1/5 Under an hour Newbie friendliness 78/100
redhat-developer/rhdh-plugin-export-overlays#4503 · 1 comment ·
Maintainers usually reply within 1 day
-
needs triage 📥
Difficulty 1/5 Under an hour Newbie friendliness 86/100
ethereum/ethereum-org-website#19601 ·
Maintainers usually reply within 1 day
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
cloudscape-design/components#5184 ·
Maintainers usually reply within 2 days
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
agilepathway/label-checker#805 ·
Maintainers usually reply within 1 day