Skip to content

Latest commit

 

History

History
42 lines (25 loc) · 1.03 KB

File metadata and controls

42 lines (25 loc) · 1.03 KB

MemSync Documentation

This repository contains the comprehensive documentation for MemSync, a powerful platform for building personalized AI experiences through long-term memory management.

Development

To run the documentation locally, you'll need to install and use the documentation tools.

Prerequisites

Make sure you have Node.js installed, then install the documentation CLI:

npm i -g @mintlify/mdx

Running Locally

Start the local development server:

npx @mintlify/mdx dev

The documentation will be available at http://localhost:3000.

Common Issues

  • If the dev environment isn't running - Run npm install to re-install dependencies.

Contributing

When contributing to the documentation:

  1. Follow the existing structure and formatting
  2. Test changes locally before submitting
  3. Ensure all links and references work correctly
  4. Update navigation in docs.json if adding new pages

Deployment

The documentation is automatically deployed when changes are pushed to the main branch.