-
Notifications
You must be signed in to change notification settings - Fork 17
add tutorial for flat subscription with usage based billing #102
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
base: main
Are you sure you want to change the base?
add tutorial for flat subscription with usage based billing #102
Conversation
WalkthroughAdds a new MDX tutorial "Subscription with Usage Based Billing Tutorial" describing Meter and Product setup for combining flat subscriptions with usage-based billing, and registers the page in the docs navigation under Developer Resources β Integration Guides. Changes
Sequence Diagram(s)sequenceDiagram
autonumber
participant Author as Docs Author
participant CMS as Docs CMS
participant Reader as Developer
participant Billing as Billing System
rect rgb(235,248,255)
Author->>CMS: Create Meter section (define meter, unit)
Author->>CMS: Create Product section (flat price + UBB settings)
Author->>CMS: Add images, notes, validation copy
CMS-->>Author: Save tutorial page
end
rect rgb(245,255,235)
Reader->>CMS: Open tutorial page
Note right of CMS: Reader follows steps to\ncreate Meter and Product in app
Reader->>Billing: Create Meter (runtime)
Reader->>Billing: Create Product and associate Meter
Billing-->>Reader: Subscription established (flat + usage meter)
end
Estimated code review effortπ― 2 (Simple) | β±οΈ ~10 minutes Poem
Pre-merge checks and finishing touchesβ Failed checks (1 warning)
β Passed checks (4 passed)
β¨ Finishing touchesπ§ͺ Generate unit tests (beta)
π Recent review detailsConfiguration used: CodeRabbit UI Review profile: CHILL Plan: Pro π Files selected for processing (1)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 3
π Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
β Files ignored due to path filters (4)
images/guides/subscription-with-usage-based-billing/meter.png
is excluded by!**/*.png
images/guides/subscription-with-usage-based-billing/product-1.png
is excluded by!**/*.png
images/guides/subscription-with-usage-based-billing/product-2.png
is excluded by!**/*.png
images/guides/subscription-with-usage-based-billing/product-3.png
is excluded by!**/*.png
π Files selected for processing (2)
developer-resources/subscription-with-usage-based-billing-tutorial.mdx
(1 hunks)docs.json
(1 hunks)
π§° Additional context used
π Path-based instructions (2)
**/*.{md,mdx}
π CodeRabbit inference engine (.cursor/rules/mintlify.mdc)
Every documentation page must begin with YAML frontmatter containing title and description
Files:
developer-resources/subscription-with-usage-based-billing-tutorial.mdx
**/*.mdx
π CodeRabbit inference engine (.cursor/rules/mintlify.mdc)
**/*.mdx
: Use clear, direct language appropriate for technical audiences
Write instructions in second person (you)
Use active voice over passive voice
Use present tense for current states and future tense for outcomes
Maintain consistent terminology across documentation
Keep sentences concise while preserving necessary context
Use parallel structure in lists, headings, and procedures
Lead sections with the most important information (inverted pyramid)
Use progressive disclosure: introduce basics before advanced topics
Break complex procedures into numbered steps using /
Include prerequisites and context before instructions
Provide expected outcomes for each major step
End sections with next steps or related information
Use descriptive, keyword-rich headings for navigation and SEO
Focus on user goals and outcomes rather than system features
Anticipate common questions and address them proactively
Include troubleshooting for likely failure points
Provide multiple pathways (beginner vs advanced) when appropriate, with an opinionated recommended path
Use for supplementary information that supports main content
Use for expert advice, shortcuts, or best practices
Use for critical cautions, breaking changes, or destructive actions
Use for neutral background or contextual information
Use for success confirmations or achievement indicators
Use to present the same concept in multiple languages
Provide complete, runnable code examples with language specified and filename when relevant
Include RequestExample/ResponseExample blocks for API endpoint docs
Document API parameters using (path, query, header, body) with types and required/defaults
Document API responses using with names, types, and required flags
Use for nested object properties or hierarchical information
Use / for platform-specific or alternative approaches
Use / for suppl...
Files:
developer-resources/subscription-with-usage-based-billing-tutorial.mdx
π Description
Add a tutorial for flat subscription with usage based billing
π― Type of Change
π What documentation does this PR affect?
β Checklist
mintlify dev
docs.json
(if applicable)π§ͺ Testing
πΈ Screenshots (if applicable)
π Related Issues
Closes #84
π Additional Notes
π₯ Reviewers
@dodopayments/documentation-team
Summary by CodeRabbit