Skip to content

feat: Restructure JavaScript cron monitoring documentation #14407

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.

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

Draft
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

smeubank
Copy link
Member

@smeubank smeubank commented Jul 18, 2025

experiment: included in this PR are the .cursor folder changes and product docs, all generated with AI, to experiment with docs repo changes

Preview: here

  • Transform overwhelming 275-line single page into focused method picker

  • Create separate pages for each integration approach:

    • UI Setup: Two-step process (create monitor + add notification code)
    • Automatic: Auto-instrumentation for node-cron/cron/node-schedule
    • Manual: Full SDK control with custom error handling
    • Advanced: Programmatic monitor management for CI/CD
  • Add comprehensive PRFAQ addressing real user confusion

  • Include decision framework to eliminate choice paralysis

  • Add redirect alerts for backward compatibility

  • Enhance troubleshooting with issue resolution

  • Add Cursor project rules and feature development workflow

Addresses user feedback about confusing UI flow and overwhelming docs that showed 4+ methods without clear guidance on which to use.

- Transform overwhelming 275-line single page into focused method picker
- Create separate pages for each integration approach:
  * UI Setup: Two-step process (create monitor + add notification code)
  * Automatic: Auto-instrumentation for node-cron/cron/node-schedule
  * Manual: Full SDK control with custom error handling
  * Advanced: Programmatic monitor management for CI/CD

- Add comprehensive PRFAQ addressing real user confusion
- Include decision framework to eliminate choice paralysis
- Add redirect alerts for backward compatibility
- Enhance troubleshooting with issue resolution

- Add Cursor project rules and feature development workflow

Addresses user feedback about confusing UI flow and overwhelming docs
that showed 4+ methods without clear guidance on which to use.
Copy link

vercel bot commented Jul 18, 2025

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

Name Status Preview Comments Updated (UTC)
develop-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jul 18, 2025 5:36pm
sentry-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jul 18, 2025 5:36pm

Copy link

codecov bot commented Jul 18, 2025

Bundle Report

Changes will increase total bundle size by 4.54kB (0.02%) ⬆️. This is within the configured threshold ✅

Detailed changes
Bundle name Size Change
sentry-docs-client-array-push 9.84MB -6 bytes (-0.0%) ⬇️
sentry-docs-server-cjs 11.97MB 4.55kB (0.04%) ⬆️

Affected Assets, Files, and Routes:

view changes for bundle: sentry-docs-client-array-push

Assets Changed:

Asset Name Size Change Total Size Change (%)
static/chunks/pages/_app-*.js -3 bytes 881.08kB -0.0%
static/chunks/1831-*.js -3 bytes 423.46kB -0.0%
static/zU06SrIPxW50ySFQf-*.js (New) 684 bytes 684 bytes 100.0% 🚀
static/zU06SrIPxW50ySFQf-*.js (New) 77 bytes 77 bytes 100.0% 🚀
static/Gm9RPVd3HkZFQIV_PQUoO/_buildManifest.js (Deleted) -684 bytes 0 bytes -100.0% 🗑️
static/Gm9RPVd3HkZFQIV_PQUoO/_ssgManifest.js (Deleted) -77 bytes 0 bytes -100.0% 🗑️
view changes for bundle: sentry-docs-server-cjs

Assets Changed:

Asset Name Size Change Total Size Change (%)
1729.js -3 bytes 1.67MB -0.0%
../instrumentation.js -3 bytes 999.78kB -0.0%
9523.js -3 bytes 975.72kB -0.0%
../app/[[...path]]/page.js.nft.json 1.52kB 721.71kB 0.21%
../app/platform-redirect/page.js.nft.json 1.52kB 721.62kB 0.21%
../app/sitemap.xml/route.js.nft.json 1.52kB 719.6kB 0.21%

- Convert <Tabs>/<Tab> components to {tabTitle:...} syntax
- Resolves Vercel build error: 'Expected component Tab to be defined'
- Fixes prerender error on /platforms/javascript/guides/hapi/crons/advanced
- Simplify crons/index.mdx: Remove heavy card components, change 'easiest' to 'recommended'
- Add PRFAQ open questions: What's the bare minimum for working cron monitoring?
- Clarify UI-first vs code-first approach and define 'easiest' vs 'most complete'
- Ready for team review on product strategy and simplified UX
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant