aboutsummaryrefslogtreecommitdiff
path: root/apps/docs
diff options
context:
space:
mode:
authorDhravya Shah <[email protected]>2025-01-30 21:18:18 -0700
committerDhravya Shah <[email protected]>2025-01-30 21:18:18 -0700
commit05434b1c57cd35bd12e74434cf0c408a0f6c65a9 (patch)
tree93a09ece09450b873122ad13d286212ddf15554b /apps/docs
parentinitial docs setup (diff)
downloadsupermemory-05434b1c57cd35bd12e74434cf0c408a0f6c65a9.tar.xz
supermemory-05434b1c57cd35bd12e74434cf0c408a0f6c65a9.zip
redepl
Diffstat (limited to 'apps/docs')
-rw-r--r--apps/docs/changelog/overview.mdx1
-rw-r--r--apps/docs/images/setup/1.pngbin0 -> 1017363 bytes
-rw-r--r--apps/docs/images/setup/2.pngbin0 -> 653266 bytes
-rw-r--r--apps/docs/images/setup/3.pngbin0 -> 660688 bytes
-rw-r--r--apps/docs/quickstart.mdx90
5 files changed, 19 insertions, 72 deletions
diff --git a/apps/docs/changelog/overview.mdx b/apps/docs/changelog/overview.mdx
index c04403dd..14b07587 100644
--- a/apps/docs/changelog/overview.mdx
+++ b/apps/docs/changelog/overview.mdx
@@ -2,7 +2,6 @@
title: "Product Updates"
description: "New updates and improvements"
mode: "center"
-icon: "rocket"
---
<Update label="2024-10-12" description="v0.1.1">
diff --git a/apps/docs/images/setup/1.png b/apps/docs/images/setup/1.png
new file mode 100644
index 00000000..aba55dc7
--- /dev/null
+++ b/apps/docs/images/setup/1.png
Binary files differ
diff --git a/apps/docs/images/setup/2.png b/apps/docs/images/setup/2.png
new file mode 100644
index 00000000..32f195cb
--- /dev/null
+++ b/apps/docs/images/setup/2.png
Binary files differ
diff --git a/apps/docs/images/setup/3.png b/apps/docs/images/setup/3.png
new file mode 100644
index 00000000..a91ecaa4
--- /dev/null
+++ b/apps/docs/images/setup/3.png
Binary files differ
diff --git a/apps/docs/quickstart.mdx b/apps/docs/quickstart.mdx
index c44cfaaf..e2e4b65f 100644
--- a/apps/docs/quickstart.mdx
+++ b/apps/docs/quickstart.mdx
@@ -1,86 +1,34 @@
---
-title: 'Quickstart'
-description: 'Start building awesome documentation in under 5 minutes'
+title: 'Getting Started'
+description: 'Start using Supermemory API in under 5 minutes'
---
-## Setup your development
+## Getting Started
-Learn how to update your docs locally and deploy them to the public.
+To use the Supermemory API, you'll need:
-### Edit and preview
+1. An API key (get one by signing up at [supermemory.ai](https://supermemory.ai))
+2. Basic understanding of REST APIs
+3. A tool to make HTTP requests (like curl, Postman, or your favorite programming language)
<AccordionGroup>
- <Accordion icon="github" title="Clone your docs locally">
- During the onboarding process, we created a repository on your Github with
- your docs content. You can find this repository on our
- [dashboard](https://dashboard.mintlify.com). To clone the repository
- locally, follow these
- [instructions](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository)
- in your terminal.
- </Accordion>
- <Accordion icon="rectangle-terminal" title="Preview changes">
- Previewing helps you make sure your changes look as intended. We built a
- command line interface to render these changes locally. 1. Install the
- [Mintlify CLI](https://www.npmjs.com/package/mintlify) to preview the
- documentation changes locally with this command: ``` npm i -g mintlify ```
- 2. Run the following command at the root of your documentation (where
- `mint.json` is): ``` mintlify dev ```
- </Accordion>
-</AccordionGroup>
+ <Accordion icon="key" title="Getting Your API Key">
+ 1. Login into [supermemory.ai](https://supermemory.ai) and click on the "Add Memory" button
-### Deploy your changes
+ ![Login to Supermemory](/images/setup/1.png)
-<AccordionGroup>
-
-<Accordion icon="message-bot" title="Install our Github app">
- Our Github app automatically deploys your changes to your docs site, so you
- don't need to manage deployments yourself. You can find the link to install on
- your [dashboard](https://dashboard.mintlify.com). Once the bot has been
- successfully installed, there should be a check mark next to the commit hash
- of the repo.
-</Accordion>
-<Accordion icon="rocket" title="Push your changes">
- [Commit and push your changes to
- Git](https://docs.github.com/en/get-started/using-git/pushing-commits-to-a-remote-repository#about-git-push)
- for your changes to update in your docs site. If you push and don't see that
- the Github app successfully deployed your changes, you can also manually
- update your docs through our [dashboard](https://dashboard.mintlify.com).
-</Accordion>
+ 2. Click on "Integrations" in the navigation menu
-</AccordionGroup>
+ ![Navigate to Add Memory](/images/setup/2.png)
-## Update your docs
+ 3. You'll see your API key, you can copy it by clicking on the copy button
-Add content directly in your files with MDX syntax and React components. You can use any of our components, or even build your own.
+ ![View API Key in Integrations](/images/setup/3.png)
-<CardGroup>
-
-<Card title="Style Your Docs" icon="paintbrush" href="/settings/global">
- Add flair to your docs with personalized branding.
-</Card>
-
-<Card
- title="Add API Endpoints"
- icon="square-code"
- href="/api-playground/configuration"
->
- Implement your OpenAPI spec and enable API user interaction.
-</Card>
-
-<Card
- title="Integrate Analytics"
- icon="chart-mixed"
- href="/analytics/supported-integrations"
->
- Draw insights from user interactions with your documentation.
-</Card>
+ Keep your API key secure and never share it publicly. You'll need this key for authenticating all API requests.
+ </Accordion>
+</AccordionGroup>
-<Card
- title="Host on a Custom Domain"
- icon="browser"
- href="/settings/custom-domain/subdomain"
->
- Keep your docs on your own website's subdomain.
-</Card>
+## Base URL
-</CardGroup>
+All API requests should be made to: