{"templateId":"markdown","sharedDataIds":{},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Documentation Organization Guide","siteUrl":"https://platform.papr.ai","description":"Papr Memory is an AI-native memory layer that lets developers add production-ready memory to their AI agents and apps with just a few lines of code."},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"documentation-organization-guide"},"children":["Documentation Organization Guide"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"current-status"},"children":["Current Status"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The project uses Redocly with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sidebars.yaml"]}," to control what appears in customer-facing docs."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"customer-facing-docs-should-be-in-sidebars.yaml"},"children":["Customer-Facing Docs (Should be in sidebars.yaml)"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"-already-in-sidebar---good"},"children":["✅ Already in Sidebar - Good!"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["All docs currently in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sidebars.yaml"]}," are appropriate for customers:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Overview section"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Quick Start"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Deployment"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Core Concepts"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Guides"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["API Reference"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Tutorials"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["SDKs & Tools"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Examples"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Integrations"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"️-missing-from-sidebar---should-add"},"children":["⚠️ Missing from Sidebar - Should Add"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["These new comparison docs should be added to the Overview section in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sidebars.yaml"]},":"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["overview/comparison-cheat-sheet.md"]}]}," - One-page comparison (very valuable for customers)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["overview/when-do-you-need-papr.md"]}]}," - Decision guide (helps qualification)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["overview/why-papr.md"]}]}," - Detailed comparison (key for evaluation)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["overview/diy-stack-comparison.md"]}]}," - Technical deep-dive (for technical evaluators)"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"internal-docs-should-not-be-in-sidebars.yaml"},"children":["Internal Docs (Should NOT be in sidebars.yaml)"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"-currently-not-in-sidebar---good"},"children":["✅ Currently Not in Sidebar - Good!"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["These are internal planning/analysis docs and should stay out of customer view:"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Root directory internal docs"]},":"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AUDIT-ANSWERS.md"]}," - Internal audit responses"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AUDIT-SUMMARY.md"]}," - Internal audit summary"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ENTERPRISE-FEEDBACK-ANALYSIS.md"]}," - Internal feedback analysis"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["FINAL-SUMMARY.md"]}," - Internal positioning summary"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["NEW-DOCS-IMPLEMENTATION-GUIDE.md"]}," - Internal guide for using docs"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PAPR-ADVANTAGES-UPDATE.md"]}," - Internal update notes"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POSITIONING-UPDATES-SUMMARY.md"]}," - Internal positioning notes"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["QUICK-WINS-COMPLETE.md"]}," - Internal task tracking"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["REDDIT-REFERENCES-REMOVED.md"]}," - Internal change log"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["VIDEO-AUDIO-AUDIT.md"]}," - Internal audit"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DOCS-ORGANIZATION.md"]}," - This file (internal guide)"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Keep these internal docs"]},":"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Useful for team reference"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Document decision-making process"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Help with future updates"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"-borderline---decide-based-on-use"},"children":["🤔 Borderline - Decide Based on Use"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["README.md"]}]}," (root)"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Current: Not in sidebar"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Recommendation: Keep as GitHub README, not in customer docs"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Reason: Redocly has its own landing page"]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["about.md"]}]}," (root)"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Current: Not in sidebar"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Recommendation: Review content, possibly move to Overview section if customer-relevant"]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["changelog.md"]}]}," (root)"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Current: Not in sidebar"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Recommendation: Could add to sidebar as \"Changelog\" if you maintain public changelog"]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["papr-chat-template.md"]}]}," (root)"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Current: Not in sidebar"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Recommendation: If this is a customer-facing template, move to examples/ or tutorials/"]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"recommended-actions"},"children":["Recommended Actions"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"1.-update-sidebars.yaml---add-new-comparison-docs"},"children":["1. Update sidebars.yaml - Add New Comparison Docs"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Add to the Overview section (after line 19 in current sidebars.yaml):"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"yaml","header":{"controls":{"copy":{}}},"source":"- group: Overview\n  page: overview/index.md\n  items:\n    - page: overview/predictive-memory.md\n      label: Predictive Memory\n    - page: overview/unified-graph.md\n      label: Unified Graph\n    - page: overview/structured-data.md\n      label: Structured Data\n    # ADD THESE NEW ITEMS:\n    - separator: Evaluation & Comparison\n    - page: overview/comparison-cheat-sheet.md\n      label: Comparison Cheat Sheet\n    - page: overview/when-do-you-need-papr.md\n      label: When Do You Need Papr?\n    - page: overview/why-papr.md\n      label: Why Papr\n    - page: overview/diy-stack-comparison.md\n      label: DIY Stack Comparison\n    # EXISTING ITEMS CONTINUE:\n    - page: overview/capability-matrix.md\n      label: Capability Matrix\n    - page: overview/use-cases.md\n      label: Use Cases\n    - page: overview/decision-tree.md\n      label: Decision Tree\n    - page: overview/golden-paths.md\n      label: Golden Paths\n    - page: overview/content-ownership.md\n      label: Content Ownership Model\n","lang":"yaml"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"2.-move-internal-docs-to-separate-folder"},"children":["2. Move Internal Docs to Separate Folder"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Create an ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["internal/"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":[".internal/"]}," folder to clearly separate:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"mkdir -p internal/planning\nmv AUDIT-*.md internal/planning/\nmv FINAL-SUMMARY.md internal/planning/\nmv NEW-DOCS-IMPLEMENTATION-GUIDE.md internal/planning/\nmv PAPR-ADVANTAGES-UPDATE.md internal/planning/\nmv POSITIONING-UPDATES-SUMMARY.md internal/planning/\nmv QUICK-WINS-COMPLETE.md internal/planning/\nmv REDDIT-REFERENCES-REMOVED.md internal/planning/\nmv VIDEO-AUDIO-AUDIT.md internal/planning/\nmv ENTERPRISE-FEEDBACK-ANALYSIS.md internal/planning/\nmv DOCS-ORGANIZATION.md internal/planning/\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"3.-add-.gitignore-rule-optional"},"children":["3. Add .gitignore Rule (Optional)"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If you want to keep internal docs out of git:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"echo \"internal/\" >> .gitignore\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Or keep them in git but ensure Redocly ignores them (it already does by not being in sidebars.yaml)."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"4.-review-root-level-docs"},"children":["4. Review Root-Level Docs"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["README.md"]},":"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Keep as GitHub README"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Not needed in Redocly (has its own landing)"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["about.md"]},":"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Review content"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["If customer-relevant, add to sidebar"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["If internal, move to internal/"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["changelog.md"]},":"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["If maintaining public changelog, add to sidebar"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["If internal tracking, move to internal/"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["papr-chat-template.md"]},":"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["If customer template, move to examples/ or tutorials/"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["If internal, move to internal/"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"file-structure-recommendation"},"children":["File Structure Recommendation"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"memory-dev-docs/\n├── internal/                    # Internal docs (not in sidebar)\n│   └── planning/\n│       ├── AUDIT-ANSWERS.md\n│       ├── AUDIT-SUMMARY.md\n│       ├── FINAL-SUMMARY.md\n│       ├── PAPR-ADVANTAGES-UPDATE.md\n│       └── ... (other internal docs)\n│\n├── overview/                    # Customer-facing overview\n│   ├── index.md                ✅ In sidebar\n│   ├── comparison-cheat-sheet.md  ⚠️ ADD to sidebar\n│   ├── when-do-you-need-papr.md   ⚠️ ADD to sidebar\n│   ├── why-papr.md                ⚠️ ADD to sidebar\n│   ├── diy-stack-comparison.md    ⚠️ ADD to sidebar\n│   └── ... (other overview docs)\n│\n├── quickstart/                  ✅ In sidebar\n├── concepts/                    ✅ In sidebar\n├── guides/                      ✅ In sidebar\n├── tutorials/                   ✅ In sidebar\n├── examples/                    ✅ In sidebar\n├── integrations/                ✅ In sidebar\n├── sdks/                        ✅ In sidebar\n├── deployment/                  ✅ In sidebar\n│\n├── README.md                    ℹ️ GitHub only (not in sidebar)\n├── sidebars.yaml               🔧 Controls customer-facing docs\n├── redocly.yaml                🔧 Redocly config\n└── ... (other config files)\n"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"verification-checklist"},"children":["Verification Checklist"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["After making changes:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"input","attributes":{"checked":false,"type":"checkbox","readOnly":true},"children":[]}," All new comparison docs appear in customer-facing sidebar"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"input","attributes":{"checked":false,"type":"checkbox","readOnly":true},"children":[]}," All internal planning docs are NOT in sidebar"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"input","attributes":{"checked":false,"type":"checkbox","readOnly":true},"children":[]}," Internal docs moved to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["internal/"]}," folder"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"input","attributes":{"checked":false,"type":"checkbox","readOnly":true},"children":[]}," Redocly build succeeds: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["npx @redocly/cli build-docs"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"input","attributes":{"checked":false,"type":"checkbox","readOnly":true},"children":[]}," Preview looks correct: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["npx @redocly/cli preview-docs"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"input","attributes":{"checked":false,"type":"checkbox","readOnly":true},"children":[]}," No broken links in customer-facing docs"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"input","attributes":{"checked":false,"type":"checkbox","readOnly":true},"children":[]}," Navigation flows logically (Overview → Comparison → Quick Start)"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"priority-actions"},"children":["Priority Actions"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"high-priority-do-first"},"children":["High Priority (Do First)"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["✅ ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Add new comparison docs to sidebars.yaml"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["These are valuable for customers and should be discoverable"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Add under Overview section with \"Evaluation & Comparison\" separator"]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"medium-priority-do-soon"},"children":["Medium Priority (Do Soon)"]},{"$$mdtype":"Tag","name":"ol","attributes":{"start":2},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["✅ ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Move internal docs to internal/ folder"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Keeps repo organized"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Clear separation of customer vs. internal"]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"low-priority-nice-to-have"},"children":["Low Priority (Nice to Have)"]},{"$$mdtype":"Tag","name":"ol","attributes":{"start":3},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["✅ ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Review root-level docs"]}," (README, about, changelog, papr-chat-template)",{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Decide if customer-facing or internal"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Move or add to sidebar accordingly"]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"testing-customer-view"},"children":["Testing Customer View"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To verify what customers see:"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Local preview"]},":"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"npx @redocly/cli preview-docs\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Open http://localhost:4000 and verify:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["New comparison docs appear in sidebar"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Internal docs do NOT appear"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["All links work"]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Build check"]},":"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"npx @redocly/cli build-docs\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Verify no errors"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Production check"]},":"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["After deploying, visit https://platform.papr.ai"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Navigate through sidebar"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Confirm comparison docs are visible"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Confirm internal docs are NOT visible"]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"notes"},"children":["Notes"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Redocly only shows what's in sidebars.yaml"]}," - Files not in sidebar won't appear in customer docs"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Root-level .md files"]}," are typically for GitHub, not Redocly"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Internal docs"]}," can stay in repo (useful for team) but should be clearly separated"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["New comparison docs"]}," are high-value for customers and should be prominent in Overview section"]}]}]},"headings":[{"value":"Documentation Organization Guide","id":"documentation-organization-guide","depth":1},{"value":"Current Status","id":"current-status","depth":2},{"value":"Customer-Facing Docs (Should be in sidebars.yaml)","id":"customer-facing-docs-should-be-in-sidebars.yaml","depth":2},{"value":"✅ Already in Sidebar - Good!","id":"-already-in-sidebar---good","depth":3},{"value":"⚠️ Missing from Sidebar - Should Add","id":"️-missing-from-sidebar---should-add","depth":3},{"value":"Internal Docs (Should NOT be in sidebars.yaml)","id":"internal-docs-should-not-be-in-sidebars.yaml","depth":2},{"value":"✅ Currently Not in Sidebar - Good!","id":"-currently-not-in-sidebar---good","depth":3},{"value":"🤔 Borderline - Decide Based on Use","id":"-borderline---decide-based-on-use","depth":3},{"value":"Recommended Actions","id":"recommended-actions","depth":2},{"value":"1. Update sidebars.yaml - Add New Comparison Docs","id":"1.-update-sidebars.yaml---add-new-comparison-docs","depth":3},{"value":"2. Move Internal Docs to Separate Folder","id":"2.-move-internal-docs-to-separate-folder","depth":3},{"value":"3. Add .gitignore Rule (Optional)","id":"3.-add-.gitignore-rule-optional","depth":3},{"value":"4. Review Root-Level Docs","id":"4.-review-root-level-docs","depth":3},{"value":"File Structure Recommendation","id":"file-structure-recommendation","depth":2},{"value":"Verification Checklist","id":"verification-checklist","depth":2},{"value":"Priority Actions","id":"priority-actions","depth":2},{"value":"High Priority (Do First)","id":"high-priority-do-first","depth":3},{"value":"Medium Priority (Do Soon)","id":"medium-priority-do-soon","depth":3},{"value":"Low Priority (Nice to Have)","id":"low-priority-nice-to-have","depth":3},{"value":"Testing Customer View","id":"testing-customer-view","depth":2},{"value":"Notes","id":"notes","depth":2}],"frontmatter":{"seo":{"title":"Documentation Organization Guide"}},"lastModified":"2026-04-22T01:40:48.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/docs-organization","userData":{"isAuthenticated":false,"teams":["anonymous"]}}