add guide on storefront and digital product delivery #100
Conversation
… for an imaginary ebook service.
WalkthroughAdds a new developer guide MDX documenting Storefront and Digital Product Delivery (product and store creation, publishing, delivery flow including secure download links and post-purchase emails) and registers the guide in Changes
Sequence Diagram(s)sequenceDiagram
autonumber
actor Buyer
participant Storefront
participant Payment as Payment Processor
participant Delivery as Digital Delivery Service
participant Email as Email Service
rect rgb(250,250,255)
note over Buyer,Storefront: Browse & checkout
Buyer->>Storefront: View product / Add to cart / Checkout
Storefront->>Payment: Create charge
Payment-->>Storefront: Success / Failure
end
alt Payment success
rect rgb(240,255,240)
note over Storefront,Delivery: Fulfillment & delivery
Storefront->>Delivery: Request secure download link(s)
Delivery-->>Storefront: Link(s) + expiry metadata
Storefront->>Email: Send confirmation with link(s)
Email-->>Buyer: Receipt + download link(s)
Buyer->>Delivery: Download file(s)
end
else Payment failure
Storefront-->>Buyer: Show error / retry options
end
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
Pre-merge checks and finishing touches✅ Passed checks (5 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
📜 Recent review detailsConfiguration used: CodeRabbit UI Review profile: CHILL Plan: Pro 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (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 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
developer-resources/storefront-and-digital-product-delivery.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/storefront-and-digital-product-delivery.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/storefront-and-digital-product-delivery.mdx
developer-resources/storefront-and-digital-product-delivery.mdx
Outdated
Show resolved
Hide resolved
developer-resources/storefront-and-digital-product-delivery.mdx
Outdated
Show resolved
Hide resolved
developer-resources/storefront-and-digital-product-delivery.mdx
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (1)
developer-resources/storefront-and-digital-product-delivery.mdx (1)
22-128: Add explicit prerequisites before the workflow.The guide jumps straight into procedural steps without listing prerequisites, which violates the style guidance and leaves readers guessing about required access, enabled features, and assets. Please insert a “### Prerequisites” section ahead of the first block that covers items like Storefront access, Digital Product Delivery enabled, sample ebook file, and pricing details.
## Creating a Product Create a product with **Digital Product Delivery** ### Step-by-Step Product Creation -Follow this guide to create produuct with PDP feature: +### Prerequisites +- You have merchant access with Storefront and Digital Product Delivery enabled. +- You prepared your ebook file (PDF/EPUB) and cover image. +- You captured pricing, tax category, and metadata details. + +### Step-by-Step Product Creation + +Follow this guide to create a product with the Digital Product Delivery feature:
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
developer-resources/storefront-and-digital-product-delivery.mdx(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/storefront-and-digital-product-delivery.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/storefront-and-digital-product-delivery.mdx
🧠 Learnings (2)
📚 Learning: 2025-09-15T12:32:29.480Z
Learnt from: CR
PR: dodopayments/dodo-docs#0
File: .cursor/rules/mintlify.mdc:0-0
Timestamp: 2025-09-15T12:32:29.480Z
Learning: Applies to **/*.mdx : Explain prerequisites clearly before beginning instructions
Applied to files:
developer-resources/storefront-and-digital-product-delivery.mdx
📚 Learning: 2025-09-15T12:32:29.480Z
Learnt from: CR
PR: dodopayments/dodo-docs#0
File: .cursor/rules/mintlify.mdc:0-0
Timestamp: 2025-09-15T12:32:29.480Z
Learning: Applies to **/*.mdx : Include prerequisites and context before instructions
Applied to files:
developer-resources/storefront-and-digital-product-delivery.mdx
developer-resources/storefront-and-digital-product-delivery.mdx
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (1)
developer-resources/storefront-and-digital-product-delivery.mdx (1)
25-118: Add prerequisite context before the numbered steps.The style guide (and our previous review) requires a dedicated prerequisites section ahead of the procedural steps so readers know what accounts, feature flags, and assets they need before starting. Please add that context before “Step-by-Step Product Creation.”
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
developer-resources/storefront-and-digital-product-delivery.mdx(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/storefront-and-digital-product-delivery.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/storefront-and-digital-product-delivery.mdx
🧠 Learnings (2)
📚 Learning: 2025-09-15T12:32:29.480Z
Learnt from: CR
PR: dodopayments/dodo-docs#0
File: .cursor/rules/mintlify.mdc:0-0
Timestamp: 2025-09-15T12:32:29.480Z
Learning: Applies to **/*.mdx : Explain prerequisites clearly before beginning instructions
Applied to files:
developer-resources/storefront-and-digital-product-delivery.mdx
📚 Learning: 2025-09-15T12:32:29.480Z
Learnt from: CR
PR: dodopayments/dodo-docs#0
File: .cursor/rules/mintlify.mdc:0-0
Timestamp: 2025-09-15T12:32:29.480Z
Learning: Applies to **/*.mdx : Include prerequisites and context before instructions
Applied to files:
developer-resources/storefront-and-digital-product-delivery.mdx
developer-resources/storefront-and-digital-product-delivery.mdx
Outdated
Show resolved
Hide resolved
|
This follwing line doesn't make sense here. Can you also show the following?
|
|
hey @whitesideofthesun how to show the email on test payments? |
2 participants
Guide on how storefront and digital product delivery can be used for ebook service.
📋 Description
Add a guide on how storefront and digital product delivery can be used for ebook service.on
🎯 Type of Change
📖 What documentation does this PR affect?
✅ Checklist
mintlify devdocs.json(if applicable)🧪 Testing
📸 Screenshots (if applicable)
🔗 Related Issues
Closes #96
📝 Additional Notes
👥 Reviewers
@dodopayments/documentation-team
Summary by CodeRabbit