Update monitoring-tracing.mdx #6598
Conversation
Fix typos and improve understandability of documentation
📝 WalkthroughSummary by CodeRabbit
WalkthroughThe pull request includes updates to documentation, introduces new components, modifies existing components for improved styling, and updates environment variable configurations. Key changes involve grammatical corrections in the monitoring and tracing documentation, the addition of a new pricing plans table component, and modifications to the date range controller logic. Additionally, the pull request introduces new CSS easing functions and updates existing components to utilize class-based styling instead of inline styles. Changes
Possibly related PRs
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (2)
🚧 Files skipped from review as they are similar to previous changes (2)
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
|
@PlayAnyData can you please run prettier on the affected files? https://github.com/graphql-hive/console/actions/runs/13767501650/job/38503424253?pr=6598 |
Head branch was pushed to by a user without write access
|
@n1ru4l done. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Caution
Inline review comments failed to post. This is likely due to GitHub's limits when posting large numbers of comments. If you are seeing this consistently it is likely a permissions issue. Please check "Moderation" -> "Code review limits" under your organization settings.
Actionable comments posted: 1
🧹 Nitpick comments (4)
.changeset/big-cars-tie.md (1)
1-6: Consider adding the article "the" for better grammatical flow.The changeset message reads well, but adding "the" before "insights range" would improve the grammatical correctness.
-Fix insights range if selecting same start and end +Fix the insights range if selecting same start and end🧰 Tools
🪛 LanguageTool
[uncategorized] ~5-~5: You might be missing the article “the” here.
Context: ...ch --- Fix insights range if selecting same start and end(AI_EN_LECTOR_MISSING_DETERMINER_THE)
packages/web/docs/src/components/nested-sticky.tsx (1)
5-5: Consider adding a comment explaining the adjustment constantThe
BOTTOM_THRESHOLD_ADJUSTMENTconstant might be confusing for future maintainers. Consider adding a brief comment explaining why this specific value was chosen and what it accomplishes.packages/web/docs/src/components/pricing/plans-table.tsx (2)
33-34: Consider addressing the TODO commentThere's a TODO comment about moving the styling to the design system as a size="sm" property. This should be addressed to improve code maintainability and consistency with your design system.
414-418: Consider simplifying complex className conditionsThe className string in the
PlansTableCellcomponent is quite complex with multiple conditional classes. Consider extracting some of this logic into separate variables or helper functions to improve readability and maintainability.- className={cn( - 'border-beige-400 border-b border-r p-4 first:border-l first:font-medium max-md:w-1/2 max-sm:text-sm sm:py-6 md:w-1/4 [&:not(:first-child)]:border-l-0 [&:not(:first-child)]:text-center [&:not(:first-child)]:text-sm [&:not(:first-child)]:text-green-800 md:[.subheader+tr>&:last-child]:rounded-tr-3xl max-md:[.subheader+tr>&:not(:first-child,:has(+td[aria-hidden=false]))]:rounded-tr-3xl [.subheader+tr>&]:border-t [.subheader+tr>&]:first:rounded-tl-3xl md:[tr:is(:has(+.subheader),:last-child)>&:last-child]:rounded-br-3xl max-md:[tr:is(:has(+.subheader),:last-child)>&:not(:first-child,:has(+td[aria-hidden=false]))]:rounded-br-3xl [tr:is(:last-child,:has(+.subheader))>&]:first:rounded-bl-3xl', - plan && plan !== currentPlan && 'max-md:hidden', - className, - )} + const baseClasses = 'border-beige-400 border-b border-r p-4 first:border-l first:font-medium'; + const responsiveClasses = 'max-md:w-1/2 max-sm:text-sm sm:py-6 md:w-1/4'; + const nonFirstChildClasses = '[&:not(:first-child)]:border-l-0 [&:not(:first-child)]:text-center [&:not(:first-child)]:text-sm [&:not(:first-child)]:text-green-800'; + const roundedCornerClasses = 'md:[.subheader+tr>&:last-child]:rounded-tr-3xl max-md:[.subheader+tr>&:not(:first-child,:has(+td[aria-hidden=false]))]:rounded-tr-3xl [.subheader+tr>&]:border-t [.subheader+tr>&]:first:rounded-tl-3xl md:[tr:is(:has(+.subheader),:last-child)>&:last-child]:rounded-br-3xl max-md:[tr:is(:has(+.subheader),:last-child)>&:not(:first-child,:has(+td[aria-hidden=false]))]:rounded-br-3xl [tr:is(:last-child,:has(+.subheader))>&]:first:rounded-bl-3xl'; + const hiddenPlanClass = plan && plan !== currentPlan ? 'max-md:hidden' : ''; + + className={cn( + baseClasses, + responsiveClasses, + nonFirstChildClasses, + roundedCornerClasses, + hiddenPlanClass, + className, + )}
🛑 Comments failed to post (1)
packages/web/docs/src/content/gateway/logging-and-error-handling.mdx (1)
29-29:
⚠️ Potential issueCorrect environment variable name for JSON logging format.
This change fixes an important documentation error by correctly specifying
LOG_FORMAT=jsoninstead ofLOG_LEVEL=json. The environment variable name now properly reflects its purpose - controlling the output format rather than the log severity level.
Fix typos and improve readability of documentation