feat: Restructure JavaScript cron monitoring documentation #14407
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- 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.
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
Bundle ReportChanges will increase total bundle size by 9.25kB (0.04%) ⬆️. This is within the configured threshold ✅ Detailed changes
Affected Assets, Files, and Routes:view changes for bundle: sentry-docs-server-cjsAssets Changed:
view changes for bundle: sentry-docs-client-array-pushAssets Changed:
|
- 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
- Add comprehensive platform checklist for cron docs improvements - Update product docs with real implementation details and success metrics - Restructure .cursor/rules for language-agnostic documentation - Establish content strategy framework for cross-platform consistency - Create scope matrix to prevent content duplication - Document proven patterns from JavaScript platform success (60% content reduction) This framework enables systematic documentation improvements across all Sentry platforms while maintaining consistency and reducing maintenance overhead.
Core documentation implementation: - Simplified main cron index page with clear method categorization - Created dedicated pages for each manual method (job-monitoring, check-ins, heartbeat, upserting) - Added automatic integration pages for cron-library, node-cron, node-schedule - Converted troubleshooting to concise FAQ format (4 key issues) - Removed manual.mdx (redundant with individual method pages) - Added shared cron configuration properties include Content improvements: - 60% reduction in average page length (200+ lines → 50-80 lines) - Essential-first structure: purpose → when to use → quick example → links - Eliminated duplicate content and verbose explanations - Working, tested code examples for all methods - Progressive disclosure (advanced topics linked, not inline) Updated feature documentation: - Enhanced PRD and PRFAQ with real implementation learnings - Documented proven patterns for cross-platform application This demonstrates the unified documentation framework in action on the JavaScript platform, serving as the reference implementation for other platforms.
Move PLATFORM-CRON-DOCS-CHECKLIST.md from project root to the 005-unified-cron-monitoring-experience feature folder where it logically belongs. This keeps all related documentation and implementation guidance together in one cohesive feature package.
…ssing JS platforms Corrections: - Clarify that Phase 1 completed Next.js, SvelteKit, Remix, NestJS (not base Node.js) - Add Node.js base patterns as completed (established during framework work) Additions: - Add missing JavaScript platforms: Koa, Hapi, Deno, Bun - Add Express for review (may have existing patterns) Special Requirements: - Add detailed Next.js + Vercel integration requirements - Specify automatic-vercel.mdx page creation - Include content structure from existing Vercel documentation - Note Pages Router vs App Router limitations Updated Rollout Schedule: - Phase 1: Complete remaining JavaScript platforms first - Phases 2-3: Continue with Python, PHP, Java, etc.
- Add Next.js Vercel automatic integration page - Create comprehensive Next.js crons main page with proper navigation - Simplify Vercel integration content to be concise and actionable - Update platform checklist to reflect Next.js completion - Revert Nuxt changes (missing sub-pages, moved back to pending) - Remove Nuxt from supported platforms in common JS crons Next.js now has complete cron monitoring documentation including: - Main crons page with all setup methods - Dedicated Vercel automatic integration page - Proper cross-references and navigation structure
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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:
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.