diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml new file mode 100644 index 0000000..d65a016 --- /dev/null +++ b/.github/workflows/docs.yml @@ -0,0 +1,68 @@ +name: Deploy Documentation + +on: + push: + branches: [main] + paths: + - 'V0/landing/**' + - 'V0/mkdocs.pages.yml' + - '.github/workflows/docs.yml' + pull_request: + branches: [main] + paths: + - 'V0/landing/**' + - 'V0/mkdocs.pages.yml' + - '.github/workflows/docs.yml' + workflow_dispatch: + +permissions: + contents: read + pages: write + id-token: write + +concurrency: + group: pages + cancel-in-progress: false + +jobs: + build: + runs-on: ubuntu-latest + defaults: + run: + working-directory: V0 + steps: + - name: Checkout + uses: actions/checkout@v7 + + - name: Setup Python + uses: actions/setup-python@v7 + with: + python-version: '3.13' + + - name: Install MkDocs + run: python -m pip install mkdocs-material + + - name: Setup Pages + if: github.ref == 'refs/heads/main' + uses: actions/configure-pages@v6 + + - name: Build landing page + run: mkdocs build --config-file mkdocs.pages.yml --clean --strict + + - name: Upload artifact + if: github.ref == 'refs/heads/main' + uses: actions/upload-pages-artifact@v5 + with: + path: V0/site + + deploy: + if: github.ref == 'refs/heads/main' + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + runs-on: ubuntu-latest + needs: build + steps: + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v5 diff --git a/V0/landing/index.md b/V0/landing/index.md new file mode 100644 index 0000000..ba73b1f --- /dev/null +++ b/V0/landing/index.md @@ -0,0 +1,32 @@ +--- +hide: + - navigation + - toc + - footer +--- + +# Redis Agent Memory + +## Give your AI agents memory that lasts + +Redis Agent Memory is the supported Redis service for persistent agent memory. +It gives AI agents fast session memory and durable long-term memory through a +REST API and client libraries. It includes secure API key management, +configurable memory schemas, and automatic TTL-based lifecycle management. + +Redis Agent Memory is part of [Redis Iris](https://redis.io/iris/), the +real-time context engine for agents. + +[Read the official documentation](https://redis.io/docs/latest/develop/ai/context-engine/agent-memory/){ .md-button .md-button--primary } +[Explore Redis Agent Memory](https://redis.io/agent-memory/){ .md-button } + +--- + +## Looking for the original open-source server? + +The original Redis Agent Memory Server is still available as an open-source +research foundation. You can use it to learn, experiment, and review the +reference implementation, but it is not the supported production path. + +[Browse the open-source server documentation](https://github.com/redis/agent-memory-server/blob/main/V0/docs/index.md){ .md-button } +[View the source](https://github.com/redis/agent-memory-server/tree/main/V0){ .md-button } diff --git a/V0/mkdocs.pages.yml b/V0/mkdocs.pages.yml new file mode 100644 index 0000000..aa3059c --- /dev/null +++ b/V0/mkdocs.pages.yml @@ -0,0 +1,40 @@ +site_name: Redis Agent Memory +site_description: The supported Redis product for persistent agent memory +site_url: https://redis.github.io/agent-memory-server/ +repo_url: https://github.com/redis/agent-memory-server +repo_name: redis/agent-memory-server + +docs_dir: landing +site_dir: site + +theme: + name: material + palette: + - media: "(prefers-color-scheme)" + toggle: + icon: material/brightness-auto + name: Switch to light mode + - media: "(prefers-color-scheme: light)" + scheme: default + primary: red + accent: red + toggle: + icon: material/brightness-7 + name: Switch to dark mode + - media: "(prefers-color-scheme: dark)" + scheme: slate + primary: red + accent: red + toggle: + icon: material/brightness-4 + name: Switch to system preference + icon: + repo: fontawesome/brands/github + +nav: + - Redis Agent Memory: index.md + +plugins: [] + +markdown_extensions: + - attr_list