Skip to content

Added improved docs index and overview pages and quickstart #3603

Merged
deshraj merged 11 commits intomainfrom
docs_revamp/iteration1
Oct 22, 2025
Merged

Added improved docs index and overview pages and quickstart #3603
deshraj merged 11 commits intomainfrom
docs_revamp/iteration1

Conversation

@parthshr370
Copy link
Copy Markdown
Contributor

Description

  • Added indexing
  • welcome page
  • overview page for each tab
  • with corresponding quick start
  • in line with v1.0 changes now

Fixes # (issue)

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Refactor (does not change functionality, e.g. code style improvements, linting)
  • Documentation update

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

Please delete options that are not relevant.

  • Unit Test
  • Test Script (please provide)

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules
  • I have checked my code and corrected any misspellings

Maintainer Checklist

  • closes #xxxx (Replace xxxx with the GitHub issue number)
  • Made sure Checks passed

@parthshr370 parthshr370 requested a review from Copilot October 17, 2025 08:59
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR implements a comprehensive documentation reorganization and indexing system aligned with v1.0 changes. It restructures the docs navigation with dedicated tabs for Platform, Open Source, and OpenMemory, adds new index and overview pages, and provides improved quickstart guides tailored to each deployment option.

Key changes:

  • Replaced single quickstart with dedicated Platform and OSS quickstart guides
  • Added platform vs open source comparison page
  • Enhanced overview pages with clearer navigation and feature highlights
  • Restructured docs.json with organized tab-based navigation

Reviewed Changes

Copilot reviewed 11 out of 12 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
docs/quickstart.mdx Completely removed original unified quickstart (418 lines deleted)
docs/platform/quickstart.mdx Added focused Platform quickstart with prerequisite-based structure
docs/platform/platform-vs-oss.mdx New comparison guide between Platform and OSS options
docs/platform/overview.mdx Enhanced Platform overview with before/after examples and capabilities
docs/open-source/python-quickstart.mdx Streamlined OSS Python quickstart focused on essential setup
docs/open-source/overview.mdx Enhanced OSS overview with clear value propositions and navigation
docs/open-source/configuration.mdx New comprehensive configuration guide for OSS deployments
docs/introduction.mdx Redesigned welcome page with modern layout and product navigation
docs/docs.json Restructured navigation with organized tabs and improved grouping
docs/api-reference/organizations-projects.mdx New dedicated page for multi-tenant API documentation
docs/api-reference.mdx Streamlined API overview focusing on core operations

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

@parshvadaftari
Copy link
Copy Markdown
Contributor

@parthshr370 Can you resolve merge conflicts?

Copy link
Copy Markdown
Contributor

@parshvadaftari parshvadaftari left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Rest of it looks good to me.

@parthshr370 parthshr370 force-pushed the docs_revamp/iteration1 branch from 28dbbe4 to f89cb39 Compare October 21, 2025 21:09
@deshraj deshraj merged commit f7d7c53 into main Oct 22, 2025
3 of 5 checks passed
garciaba79 pushed a commit to garciaba79/mem0 that referenced this pull request Feb 12, 2026
@deshraj deshraj deleted the docs_revamp/iteration1 branch February 23, 2026 02:01
jamebobob pushed a commit to jamebobob/mem0-vigil-recall that referenced this pull request Mar 29, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants