[docs] Reduce repetitive content and simplify examples

[psnet]

Original Content

Dont want to hurt anyone, but there some problems in docs.

Docs of this package has a lot of repetitive information can be found in other docs, it is very hard to read the same text again and again on different doc pages feeling maybe something changed in it otherwise why it will be duplicated?

I think need to make prerequisites where explain about common strict reqs: product id, pub in store to test, usage of real device, kotlin version etc and no more need to tell this info again and again on every page.

Examples

Too many too long examples with unnecessary code. Build simpler "quick start" with minimal info: one code for one time purchases, another for subscription etc.
Why examples have mixed products combined ALL together in same array?! Then you filter that array.

Overengineered and overheaded examples so hard to read.

Afterwards

Simplicity is not in word of docs, but in short example: init, perform, complete.

Right now is so hard to navigate documentation.

P.S. Again: dont want to hurt anyone

---

Overview

The documentation has structural issues that make it difficult to follow and maintain. There's significant repetition of common requirements across multiple pages, and the examples are overly complex.

Problem 1: Repetitive Content

Many pages repeat the same prerequisite information:

• Product ID requirements
• Publishing to store for testing
• Real device usage requirements
• Kotlin version compatibility

Suggested Solution: Create a single "Prerequisites" section that covers all common strict requirements once, then reference it from other pages instead of repeating the information.

Problem 2: Overly Complex Examples

The current examples are difficult to follow:

• Too much unnecessary code
• Multiple product types mixed together in a single array, then filtered
• Overengineered approach that obscures the core logic

Suggested Solution: Provide simpler, focused examples:

• One minimal example for one-time purchases
• One minimal example for subscriptions
• Each example should show: init → perform → complete

Problem 3: Navigation and Readability

The documentation is hard to navigate overall. Simplifying examples and reducing repetition should improve this significantly.

Additional Notes

This feedback is constructive and appreciated. These changes would make the documentation more maintainable and user-friendly.

---

🤖 Formatted by gitdog.dev

[gitdogdev]

@psnet ## Analysis of Documentation Repetition

You're absolutely right. I found significant repetition in the docs:

Identified Repetitive Content

1. Prerequisites & Requirements (repeated across pages):

• Kotlin 2.0+ requirement for Android
• iOS 15+ for StoreKit 2
• Development build requirement (not Expo Go)
• Product ID setup in stores
• Real device testing requirement

These appear in:

• docs/docs/getting-started/installation.md
• docs/docs/guides/purchases.md
• docs/docs/guides/lifecycle.md
• docs/docs/examples/subscription-flow.md

2. Setup & Initialization (repeated code):

• useIAP() hook initialization pattern
• initConnection() flow
• Event listener setup
• Purchase callback patterns

These appear in:

• docs/docs/guides/purchases.md (lines 40-100)
• docs/docs/examples/subscription-flow.md (lines 32-110)
• docs/docs/examples/available-purchases.md
• docs/docs/index.md (Quick Start section)

3. Overengineered Examples:

• Examples combine consumables + subscriptions in one array with filtering
• Excessive code with mixed concerns
• Hard to extract minimal "copy-paste" examples

Recommended Refactoring

Step 1: Create a "Prerequisites" section
Add docs/docs/getting-started/prerequisites.md with:

• Single source of truth for all requirements
• Platform-specific requirements
• Real device vs emulator info
• Store setup (product IDs, publishing to test)
• Kotlin version table
• Development build explanation

Link to this from all other pages instead of repeating.

Step 2: Simplify Examples
Create minimal "quick start" examples:

• examples/minimal-purchase.tsx - just buy a product
• examples/minimal-subscription.tsx - just subscribe
• examples/restore-purchases.tsx - just restore
• examples/error-handling.tsx - just error cases

Then link to these from guides instead of embedding full code.

Step 3: Create Reusable Code Snippets
Add docs/docs/snippets/ directory:

• initialization.tsx - useIAP + initConnection
• event-listeners.tsx - all listener setup
• error-handling.tsx - try/catch patterns
• platform-specific.tsx - iOS vs Android differences

Use :::info blocks to include these snippets in multiple pages without duplication.

Step 4: Consolidate Platform-Specific Info
Instead of repeating iOS/Android differences in every guide:

• Create docs/docs/guides/platform-differences.md
• Use comparison tables for side-by-side requirements
• Link from other pages: "See Platform Differences for iOS-specific setup"

Step 5: Simplify Getting Started Flow
Current flow (confusing):

1. Installation → lists all prerequisites
2. Quick Start → repeats prerequisites + basic setup
3. Purchases Guide → repeats prerequisites + setup again
4. Examples → repeat everything again

Better flow:

1. Installation → just npm/yarn commands
2. Prerequisites → all requirements in one place
3. Quick Start → minimal working example (3-5 lines)
4. Guides → link to prerequisites, focus on concepts
5. Examples → focused, minimal, copy-paste ready

Implementation Priority

High Priority (causes most confusion):

• Extract prerequisites to single page
• Create minimal quick-start example
• Add reusable snippets directory

Medium Priority (improves maintainability):

• Simplify existing examples
• Consolidate platform differences
• Add snippet includes to guides

Low Priority (nice to have):

• Add interactive examples
• Add video walkthroughs
• Add troubleshooting matrix

Estimated Effort

• Prerequisites page: 1-2 hours
• Minimal examples: 2-3 hours
• Snippets directory: 1-2 hours
• Update existing docs to link: 2-3 hours
• Total: 6-10 hours for significant improvement

Would you like me to start with any of these? I'd recommend beginning with the Prerequisites page since it unblocks the other refactoring work.

---

🤖 Generated by gitdog.dev · Have more questions? Tag @gitdog and let me know!