diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 000000000..c89c478d1 --- /dev/null +++ b/docs/README.md @@ -0,0 +1,32 @@ +# Mintlify Starter Kit + +Click on `Use this template` to copy the Mintlify starter kit. The starter kit contains examples including + +- Guide pages +- Navigation +- Customizations +- API Reference pages +- Use of popular components + +### Development + +Install the [Mintlify CLI](https://www.npmjs.com/package/mintlify) to preview the documentation changes locally. To install, use the following command + +``` +npm i -g mintlify +``` + +Run the following command at the root of your documentation (where mint.json is) + +``` +mintlify dev +``` + +### Publishing Changes + +Install our Github App to autopropagate changes from youre repo to your deployment. Changes will be deployed to production automatically after pushing to the default branch. Find the link to install on your dashboard. + +#### Troubleshooting + +- Mintlify dev isn't running - Run `mintlify install` it'll re-install dependencies. +- Page loads as a 404 - Make sure you are running in a folder with `mint.json` diff --git a/docs/_snippets/snippet-example.mdx b/docs/_snippets/snippet-example.mdx new file mode 100644 index 000000000..089334c54 --- /dev/null +++ b/docs/_snippets/snippet-example.mdx @@ -0,0 +1,3 @@ +## My Snippet + +This is an example of a reusable snippet diff --git a/docs/api-reference/endpoint/create.mdx b/docs/api-reference/endpoint/create.mdx new file mode 100644 index 000000000..5689f1b65 --- /dev/null +++ b/docs/api-reference/endpoint/create.mdx @@ -0,0 +1,4 @@ +--- +title: 'Create Plant' +openapi: 'POST /plants' +--- diff --git a/docs/api-reference/endpoint/delete.mdx b/docs/api-reference/endpoint/delete.mdx new file mode 100644 index 000000000..657dfc871 --- /dev/null +++ b/docs/api-reference/endpoint/delete.mdx @@ -0,0 +1,4 @@ +--- +title: 'Delete Plant' +openapi: 'DELETE /plants/{id}' +--- diff --git a/docs/api-reference/endpoint/get.mdx b/docs/api-reference/endpoint/get.mdx new file mode 100644 index 000000000..56aa09ec1 --- /dev/null +++ b/docs/api-reference/endpoint/get.mdx @@ -0,0 +1,4 @@ +--- +title: 'Get Plants' +openapi: 'GET /plants' +--- diff --git a/docs/api-reference/introduction.mdx b/docs/api-reference/introduction.mdx new file mode 100644 index 000000000..c835b78b5 --- /dev/null +++ b/docs/api-reference/introduction.mdx @@ -0,0 +1,33 @@ +--- +title: 'Introduction' +description: 'Example section for showcasing API endpoints' +--- + + + If you're not looking to build API reference documentation, you can delete + this section by removing the api-reference folder. + + +## Welcome + +There are two ways to build API documentation: [OpenAPI](https://mintlify.com/docs/api-playground/openapi/setup) and [MDX components](https://mintlify.com/docs/api-playground/mdx/configuration). For the starter kit, we are using the following OpenAPI specification. + + + View the OpenAPI specification file + + +## Authentication + +All API endpoints are authenticated using Bearer tokens and picked up from the specification file. + +```json +"security": [ + { + "bearerAuth": [] + } +] +``` diff --git a/docs/api-reference/openapi.json b/docs/api-reference/openapi.json new file mode 100644 index 000000000..b1509be04 --- /dev/null +++ b/docs/api-reference/openapi.json @@ -0,0 +1,195 @@ +{ + "openapi": "3.0.1", + "info": { + "title": "OpenAPI Plant Store", + "description": "A sample API that uses a plant store as an example to demonstrate features in the OpenAPI specification", + "license": { + "name": "MIT" + }, + "version": "1.0.0" + }, + "servers": [ + { + "url": "http://sandbox.mintlify.com" + } + ], + "security": [ + { + "bearerAuth": [] + } + ], + "paths": { + "/plants": { + "get": { + "description": "Returns all plants from the system that the user has access to", + "parameters": [ + { + "name": "limit", + "in": "query", + "description": "The maximum number of results to return", + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "Plant response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Plant" + } + } + } + } + }, + "400": { + "description": "Unexpected error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + }, + "post": { + "description": "Creates a new plant in the store", + "requestBody": { + "description": "Plant to add to the store", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/NewPlant" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "plant response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Plant" + } + } + } + }, + "400": { + "description": "unexpected error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/plants/{id}": { + "delete": { + "description": "Deletes a single plant based on the ID supplied", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "ID of plant to delete", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "responses": { + "204": { + "description": "Plant deleted", + "content": {} + }, + "400": { + "description": "unexpected error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + } + }, + "components": { + "schemas": { + "Plant": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "description": "The name of the plant", + "type": "string" + }, + "tag": { + "description": "Tag to specify the type", + "type": "string" + } + } + }, + "NewPlant": { + "allOf": [ + { + "$ref": "#/components/schemas/Plant" + }, + { + "required": [ + "id" + ], + "type": "object", + "properties": { + "id": { + "description": "Identification number of the plant", + "type": "integer", + "format": "int64" + } + } + } + ] + }, + "Error": { + "required": [ + "error", + "message" + ], + "type": "object", + "properties": { + "error": { + "type": "integer", + "format": "int32" + }, + "message": { + "type": "string" + } + } + } + }, + "securitySchemes": { + "bearerAuth": { + "type": "http", + "scheme": "bearer" + } + } + } +} \ No newline at end of file diff --git a/docs/development.mdx b/docs/development.mdx new file mode 100644 index 000000000..878300893 --- /dev/null +++ b/docs/development.mdx @@ -0,0 +1,98 @@ +--- +title: 'Development' +description: 'Learn how to preview changes locally' +--- + + + **Prerequisite** You should have installed Node.js (version 18.10.0 or + higher). + + +Step 1. Install Mintlify on your OS: + + + +```bash npm +npm i -g mintlify +``` + +```bash yarn +yarn global add mintlify +``` + + + +Step 2. Go to the docs are located (where you can find `mint.json`) and run the following command: + +```bash +mintlify dev +``` + +The documentation website is now available at `http://localhost:3000`. + +### Custom Ports + +Mintlify uses port 3000 by default. You can use the `--port` flag to customize the port Mintlify runs on. For example, use this command to run in port 3333: + +```bash +mintlify dev --port 3333 +``` + +You will see an error like this if you try to run Mintlify in a port that's already taken: + +```md +Error: listen EADDRINUSE: address already in use :::3000 +``` + +## Mintlify Versions + +Each CLI is linked to a specific version of Mintlify. Please update the CLI if your local website looks different than production. + + + +```bash npm +npm i -g mintlify@latest +``` + +```bash yarn +yarn global upgrade mintlify +``` + + + +## Deployment + + + Unlimited editors available under the [Startup + Plan](https://mintlify.com/pricing) + + +You should see the following if the deploy successfully went through: + + + + + +## Troubleshooting + +Here's how to solve some common problems when working with the CLI. + + + + Update to Node v18. Run `mintlify install` and try again. + + +Go to the `C:/Users/Username/.mintlify/` directory and remove the `mint` +folder. Then Open the Git Bash in this location and run `git clone +https://github.com/mintlify/mint.git`. + +Repeat step 3. + + + + Try navigating to the root of your device and delete the ~/.mintlify folder. + Then run `mintlify dev` again. + + + +Curious about what changed in a CLI version? [Check out the CLI changelog.](/changelog/command-line) diff --git a/docs/essentials/code.mdx b/docs/essentials/code.mdx new file mode 100644 index 000000000..d2a462a7a --- /dev/null +++ b/docs/essentials/code.mdx @@ -0,0 +1,37 @@ +--- +title: 'Code Blocks' +description: 'Display inline code and code blocks' +icon: 'code' +--- + +## Basic + +### Inline Code + +To denote a `word` or `phrase` as code, enclose it in backticks (`). + +``` +To denote a `word` or `phrase` as code, enclose it in backticks (`). +``` + +### Code Block + +Use [fenced code blocks](https://www.markdownguide.org/extended-syntax/#fenced-code-blocks) by enclosing code in three backticks and follow the leading ticks with the programming language of your snippet to get syntax highlighting. Optionally, you can also write the name of your code after the programming language. + +```java HelloWorld.java +class HelloWorld { + public static void main(String[] args) { + System.out.println("Hello, World!"); + } +} +``` + +````md +```java HelloWorld.java +class HelloWorld { + public static void main(String[] args) { + System.out.println("Hello, World!"); + } +} +``` +```` diff --git a/docs/essentials/images.mdx b/docs/essentials/images.mdx new file mode 100644 index 000000000..4c1517777 --- /dev/null +++ b/docs/essentials/images.mdx @@ -0,0 +1,59 @@ +--- +title: 'Images and Embeds' +description: 'Add image, video, and other HTML elements' +icon: 'image' +--- + + + +## Image + +### Using Markdown + +The [markdown syntax](https://www.markdownguide.org/basic-syntax/#images) lets you add images using the following code + +```md +![title](/path/image.jpg) +``` + +Note that the image file size must be less than 5MB. Otherwise, we recommend hosting on a service like [Cloudinary](https://cloudinary.com/) or [S3](https://aws.amazon.com/s3/). You can then use that URL and embed. + +### Using Embeds + +To get more customizability with images, you can also use [embeds](/writing-content/embed) to add images + +```html + +``` + +## Embeds and HTML elements + + + +
+ + + +Mintlify supports [HTML tags in Markdown](https://www.markdownguide.org/basic-syntax/#html). This is helpful if you prefer HTML tags to Markdown syntax, and lets you create documentation with infinite flexibility. + + + +### iFrames + +Loads another HTML page within the document. Most commonly used for embedding videos. + +```html + +``` diff --git a/docs/essentials/markdown.mdx b/docs/essentials/markdown.mdx new file mode 100644 index 000000000..c8ad9c1f3 --- /dev/null +++ b/docs/essentials/markdown.mdx @@ -0,0 +1,88 @@ +--- +title: 'Markdown Syntax' +description: 'Text, title, and styling in standard markdown' +icon: 'text-size' +--- + +## Titles + +Best used for section headers. + +```md +## Titles +``` + +### Subtitles + +Best use to subsection headers. + +```md +### Subtitles +``` + + + +Each **title** and **subtitle** creates an anchor and also shows up on the table of contents on the right. + + + +## Text Formatting + +We support most markdown formatting. Simply add `**`, `_`, or `~` around text to format it. + +| Style | How to write it | Result | +| ------------- | ----------------- | --------------- | +| Bold | `**bold**` | **bold** | +| Italic | `_italic_` | _italic_ | +| Strikethrough | `~strikethrough~` | ~strikethrough~ | + +You can combine these. For example, write `**_bold and italic_**` to get **_bold and italic_** text. + +You need to use HTML to write superscript and subscript text. That is, add `` or `` around your text. + +| Text Size | How to write it | Result | +| ----------- | ------------------------ | ---------------------- | +| Superscript | `superscript` | superscript | +| Subscript | `subscript` | subscript | + +## Linking to Pages + +You can add a link by wrapping text in `[]()`. You would write `[link to google](https://google.com)` to [link to google](https://google.com). + +Links to pages in your docs need to be root-relative. Basically, you should include the entire folder path. For example, `[link to text](/writing-content/text)` links to the page "Text" in our components section. + +Relative links like `[link to text](../text)` will open slower because we cannot optimize them as easily. + +## Blockquotes + +### Singleline + +To create a blockquote, add a `>` in front of a paragraph. + +> Dorothy followed her through many of the beautiful rooms in her castle. + +```md +> Dorothy followed her through many of the beautiful rooms in her castle. +``` + +### Multiline + +> Dorothy followed her through many of the beautiful rooms in her castle. +> +> The Witch bade her clean the pots and kettles and sweep the floor and keep the fire fed with wood. + +```md +> Dorothy followed her through many of the beautiful rooms in her castle. +> +> The Witch bade her clean the pots and kettles and sweep the floor and keep the fire fed with wood. +``` + +### LaTeX + +Mintlify supports [LaTeX](https://www.latex-project.org) through the Latex component. + +8 x (vk x H1 - H2) = (0,1) + +```md +8 x (vk x H1 - H2) = (0,1) +``` diff --git a/docs/essentials/navigation.mdx b/docs/essentials/navigation.mdx new file mode 100644 index 000000000..ca44bb645 --- /dev/null +++ b/docs/essentials/navigation.mdx @@ -0,0 +1,66 @@ +--- +title: 'Navigation' +description: 'The navigation field in mint.json defines the pages that go in the navigation menu' +icon: 'map' +--- + +The navigation menu is the list of links on every website. + +You will likely update `mint.json` every time you add a new page. Pages do not show up automatically. + +## Navigation syntax + +Our navigation syntax is recursive which means you can make nested navigation groups. You don't need to include `.mdx` in page names. + + + +```json Regular Navigation +"navigation": [ + { + "group": "Getting Started", + "pages": ["quickstart"] + } +] +``` + +```json Nested Navigation +"navigation": [ + { + "group": "Getting Started", + "pages": [ + "quickstart", + { + "group": "Nested Reference Pages", + "pages": ["nested-reference-page"] + } + ] + } +] +``` + + + +## Folders + +Simply put your MDX files in folders and update the paths in `mint.json`. + +For example, to have a page at `https://yoursite.com/your-folder/your-page` you would make a folder called `your-folder` containing an MDX file called `your-page.mdx`. + + + +You cannot use `api` for the name of a folder unless you nest it inside another folder. Mintlify uses Next.js which reserves the top-level `api` folder for internal server calls. A folder name such as `api-reference` would be accepted. + + + +```json Navigation With Folder +"navigation": [ + { + "group": "Group Name", + "pages": ["your-folder/your-page"] + } +] +``` + +## Hidden Pages + +MDX files not included in `mint.json` will not show up in the sidebar but are accessible through the search bar and by linking directly to them. diff --git a/docs/essentials/settings.mdx b/docs/essentials/settings.mdx new file mode 100644 index 000000000..ae6e7d6ab --- /dev/null +++ b/docs/essentials/settings.mdx @@ -0,0 +1,318 @@ +--- +title: 'Global Settings' +description: 'Mintlify gives you complete control over the look and feel of your documentation using the mint.json file' +icon: 'gear' +--- + +Every Mintlify site needs a `mint.json` file with the core configuration settings. Learn more about the [properties](#properties) below. + +## Properties + + +Name of your project. Used for the global title. + +Example: `mintlify` + + + + + An array of groups with all the pages within that group + + + The name of the group. + + Example: `Settings` + + + + The relative paths to the markdown files that will serve as pages. + + Example: `["customization", "page"]` + + + + + + + + Path to logo image or object with path to "light" and "dark" mode logo images + + + Path to the logo in light mode + + + Path to the logo in dark mode + + + Where clicking on the logo links you to + + + + + + Path to the favicon image + + + + Hex color codes for your global theme + + + The primary color. Used for most often for highlighted content, section + headers, accents, in light mode + + + The primary color for dark mode. Used for most often for highlighted + content, section headers, accents, in dark mode + + + The primary color for important buttons + + + The color of the background in both light and dark mode + + + The hex color code of the background in light mode + + + The hex color code of the background in dark mode + + + + + + + + Array of `name`s and `url`s of links you want to include in the topbar + + + The name of the button. + + Example: `Contact us` + + + The url once you click on the button. Example: `https://mintlify.com/contact` + + + + + + + + + Link shows a button. GitHub shows the repo information at the url provided including the number of GitHub stars. + + + If `link`: What the button links to. + + If `github`: Link to the repository to load GitHub information from. + + + Text inside the button. Only required if `type` is a `link`. + + + + + + + Array of version names. Only use this if you want to show different versions + of docs with a dropdown in the navigation bar. + + + + An array of the anchors, includes the `icon`, `color`, and `url`. + + + The [Font Awesome](https://fontawesome.com/search?s=brands%2Cduotone) icon used to feature the anchor. + + Example: `comments` + + + The name of the anchor label. + + Example: `Community` + + + The start of the URL that marks what pages go in the anchor. Generally, this is the name of the folder you put your pages in. + + + The hex color of the anchor icon background. Can also be a gradient if you pass an object with the properties `from` and `to` that are each a hex color. + + + Used if you want to hide an anchor until the correct docs version is selected. + + + Pass `true` if you want to hide the anchor until you directly link someone to docs inside it. + + + One of: "brands", "duotone", "light", "sharp-solid", "solid", or "thin" + + + + + + + Override the default configurations for the top-most anchor. + + + The name of the top-most anchor + + + Font Awesome icon. + + + One of: "brands", "duotone", "light", "sharp-solid", "solid", or "thin" + + + + + + An array of navigational tabs. + + + The name of the tab label. + + + The start of the URL that marks what pages go in the tab. Generally, this + is the name of the folder you put your pages in. + + + + + + Configuration for API settings. Learn more about API pages at [API Components](/api-playground/demo). + + + The base url for all API endpoints. If `baseUrl` is an array, it will enable for multiple base url + options that the user can toggle. + + + + + + The authentication strategy used for all API endpoints. + + + The name of the authentication parameter used in the API playground. + + If method is `basic`, the format should be `[usernameName]:[passwordName]` + + + The default value that's designed to be a prefix for the authentication input field. + + E.g. If an `inputPrefix` of `AuthKey` would inherit the default input result of the authentication field as `AuthKey`. + + + + + + Configurations for the API playground + + + + Whether the playground is showing, hidden, or only displaying the endpoint with no added user interactivity `simple` + + Learn more at the [playground guides](/api-playground/demo) + + + + + + Enabling this flag ensures that key ordering in OpenAPI pages matches the key ordering defined in the OpenAPI file. + + This behavior will soon be enabled by default, at which point this field will be deprecated. + + + + + + + A string or an array of strings of URL(s) or relative path(s) pointing to your + OpenAPI file. + + Examples: + + ```json Absolute + "openapi": "https://example.com/openapi.json" + ``` + ```json Relative + "openapi": "/openapi.json" + ``` + ```json Multiple + "openapi": ["https://example.com/openapi1.json", "/openapi2.json", "/openapi3.json"] + ``` + + + + + + An object of social media accounts where the key:property pair represents the social media platform and the account url. + + Example: + ```json + { + "twitter": "https://twitter.com/mintlify", + "website": "https://mintlify.com" + } + ``` + + + One of the following values `website`, `facebook`, `twitter`, `discord`, `slack`, `github`, `linkedin`, `instagram`, `hacker-news` + + Example: `twitter` + + + The URL to the social platform. + + Example: `https://twitter.com/mintlify` + + + + + + Configurations to enable feedback buttons + + + + Enables a button to allow users to suggest edits via pull requests + + + Enables a button to allow users to raise an issue about the documentation + + + + + + Customize the dark mode toggle. + + + Set if you always want to show light or dark mode for new users. When not + set, we default to the same mode as the user's operating system. + + + Set to true to hide the dark/light mode toggle. You can combine `isHidden` with `default` to force your docs to only use light or dark mode. For example: + + + ```json Only Dark Mode + "modeToggle": { + "default": "dark", + "isHidden": true + } + ``` + + ```json Only Light Mode + "modeToggle": { + "default": "light", + "isHidden": true + } + ``` + + + + + + + + + A background image to be displayed behind every page. See example with + [Infisical](https://infisical.com/docs) and [FRPC](https://frpc.io). + diff --git a/docs/favicon.svg b/docs/favicon.svg new file mode 100644 index 000000000..6a3233265 --- /dev/null +++ b/docs/favicon.svg @@ -0,0 +1,49 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/images/checks-passed.png b/docs/images/checks-passed.png new file mode 100644 index 000000000..3303c7736 Binary files /dev/null and b/docs/images/checks-passed.png differ diff --git a/docs/images/hero-dark.svg b/docs/images/hero-dark.svg new file mode 100644 index 000000000..c6a30e88b --- /dev/null +++ b/docs/images/hero-dark.svg @@ -0,0 +1,161 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/images/hero-light.svg b/docs/images/hero-light.svg new file mode 100644 index 000000000..297d68fb9 --- /dev/null +++ b/docs/images/hero-light.svg @@ -0,0 +1,155 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/introduction.mdx b/docs/introduction.mdx new file mode 100644 index 000000000..358cdd798 --- /dev/null +++ b/docs/introduction.mdx @@ -0,0 +1,71 @@ +--- +title: Introduction +description: 'Welcome to the home of your new documentation' +--- + +Hero Light +Hero Dark + +## Setting up + +The first step to world-class documentation is setting up your editing environnments. + + + + Get your docs set up locally for easy development + + + Preview your changes before you push to make sure they're perfect + + + +## Make it yours + +Update your docs to your brand and add valuable content for the best user conversion. + + + + Customize your docs to your company's colors and brands + + + Automatically generate endpoints from an OpenAPI spec + + + Build interactive features and designs to guide your users + + + Check out our showcase of our favorite documentation + + diff --git a/docs/logo/dark.svg b/docs/logo/dark.svg new file mode 100644 index 000000000..a6283786c --- /dev/null +++ b/docs/logo/dark.svg @@ -0,0 +1,55 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/logo/light.svg b/docs/logo/light.svg new file mode 100644 index 000000000..582b3b95f --- /dev/null +++ b/docs/logo/light.svg @@ -0,0 +1,51 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/mint.json b/docs/mint.json new file mode 100644 index 000000000..e29d0ec52 --- /dev/null +++ b/docs/mint.json @@ -0,0 +1,78 @@ +{ + "$schema": "https://mintlify.com/schema.json", + "name": "Starter Kit", + "logo": { + "dark": "/logo/dark.svg", + "light": "/logo/light.svg" + }, + "favicon": "/favicon.svg", + "colors": { + "primary": "#0D9373", + "light": "#07C983", + "dark": "#0D9373", + "anchors": { + "from": "#0D9373", + "to": "#07C983" + } + }, + "topbarLinks": [ + { + "name": "Support", + "url": "mailto:hi@mintlify.com" + } + ], + "topbarCtaButton": { + "name": "Dashboard", + "url": "https://dashboard.mintlify.com" + }, + "tabs": [ + { + "name": "API Reference", + "url": "api-reference" + } + ], + "anchors": [ + { + "name": "Documentation", + "icon": "book-open-cover", + "url": "https://mintlify.com/docs" + }, + { + "name": "Community", + "icon": "slack", + "url": "https://mintlify.com/community" + }, + { + "name": "Blog", + "icon": "newspaper", + "url": "https://mintlify.com/blog" + } + ], + "navigation": [ + { + "group": "Get Started", + "pages": ["introduction", "quickstart", "development"] + }, + { + "group": "Essentials", + "pages": ["essentials/markdown", "essentials/code", "essentials/images", "essentials/settings", "essentials/navigation"] + }, + { + "group": "API Documentation", + "pages": ["api-reference/introduction"] + }, + { + "group": "Endpoint Examples", + "pages": [ + "api-reference/endpoint/get", + "api-reference/endpoint/create", + "api-reference/endpoint/delete" + ] + } + ], + "footerSocials": { + "twitter": "https://twitter.com/mintlify", + "github": "https://github.com/mintlify", + "linkedin": "https://www.linkedin.com/company/mintsearch" + } +} diff --git a/docs/quickstart.mdx b/docs/quickstart.mdx new file mode 100644 index 000000000..d7f348678 --- /dev/null +++ b/docs/quickstart.mdx @@ -0,0 +1,86 @@ +--- +title: 'Quickstart' +description: 'Start building awesome documentation in under 5 minutes' +--- + +## Setup your development + +Learn how to update your docs locally and and deploy them to the public. + +### Edit and preview + + + + 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. + + + 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 ``` + + + +### Deploy your changes + + + + + 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. + + + [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). + + + + +## Update your docs + +Add content directly in your files with MDX syntax and React components. You can use any of our components, or even build your own. + + + + + Add flair to your docs with personalized branding. + + + + Implement your OpenAPI spec and enable API user interaction. + + + + Draw insights from user interactions with your documentation. + + + + Keep your docs on your own website's subdomain. + + + diff --git a/packages/api/scripts/init.sql b/packages/api/scripts/init.sql index 5b49b2250..c0695d295 100644 --- a/packages/api/scripts/init.sql +++ b/packages/api/scripts/init.sql @@ -1,6 +1,4 @@ - - -- ************************************** organizations CREATE TABLE organizations @@ -23,7 +21,7 @@ CREATE TABLE organizations CREATE TABLE entity ( id_entity uuid NOT NULL, - ressource_owner_id text NOT NULL, + ressource_owner_id uuid NOT NULL, CONSTRAINT PK_entity PRIMARY KEY ( id_entity ) ); @@ -132,6 +130,8 @@ CREATE TABLE projects id_project uuid NOT NULL, name text NOT NULL, id_organization uuid NOT NULL, + sync_mode text NOT NULL, + pull_frequency bigint NULL, CONSTRAINT PK_projects PRIMARY KEY ( id_project ), CONSTRAINT FK_6 FOREIGN KEY ( id_organization ) REFERENCES organizations ( id_organization ) ); @@ -143,6 +143,10 @@ CREATE INDEX FK_1_projects ON projects +COMMENT ON COLUMN projects.sync_mode IS 'can be realtime or periodic_pull'; +COMMENT ON COLUMN projects.pull_frequency IS 'frequency in seconds for pulls + +ex 3600 for one hour'; @@ -317,50 +321,52 @@ CREATE INDEX FK_api_keys_projects ON api_keys --- ************************************** jobs +-- ************************************** invite_links -CREATE TABLE jobs +CREATE TABLE invite_links ( - id_job uuid NOT NULL, + id_invite_link uuid NOT NULL, status text NOT NULL, - "timestamp" timestamp NOT NULL DEFAULT NOW(), + email text NULL, id_linked_user uuid NOT NULL, - CONSTRAINT PK_jobs PRIMARY KEY ( id_job ), - CONSTRAINT FK_12 FOREIGN KEY ( id_linked_user ) REFERENCES linked_users ( id_linked_user ) + CONSTRAINT PK_invite_links PRIMARY KEY ( id_invite_link ), + CONSTRAINT FK_37 FOREIGN KEY ( id_linked_user ) REFERENCES linked_users ( id_linked_user ) ); -CREATE INDEX FK_linkeduserID_projectID ON jobs +CREATE INDEX FK_invite_link_linkedUserID ON invite_links ( id_linked_user ); -COMMENT ON COLUMN jobs.status IS 'pending,, retry_scheduled, failed, success'; --- ************************************** invite_links +-- ************************************** events -CREATE TABLE invite_links +CREATE TABLE events ( - id_invite_link uuid NOT NULL, + id_event uuid NOT NULL, status text NOT NULL, - email text NULL, + type text NOT NULL, + direction text NOT NULL, + "timestamp" timestamp NOT NULL DEFAULT NOW(), id_linked_user uuid NOT NULL, - CONSTRAINT PK_invite_links PRIMARY KEY ( id_invite_link ), - CONSTRAINT FK_37 FOREIGN KEY ( id_linked_user ) REFERENCES linked_users ( id_linked_user ) + CONSTRAINT PK_jobs PRIMARY KEY ( id_event ), + CONSTRAINT FK_12 FOREIGN KEY ( id_linked_user ) REFERENCES linked_users ( id_linked_user ) ); -CREATE INDEX FK_invite_link_linkedUserID ON invite_links +CREATE INDEX FK_linkeduserID_projectID ON events ( id_linked_user ); +COMMENT ON COLUMN events.status IS 'pending,, retry_scheduled, failed, success'; @@ -414,14 +420,14 @@ CREATE TABLE jobs_status_history "timestamp" timestamp NOT NULL DEFAULT NOW(), previous_status text NOT NULL, new_status text NOT NULL, - id_job uuid NOT NULL, + id_event uuid NOT NULL, CONSTRAINT PK_jobs_status_history PRIMARY KEY ( id_jobs_status_history ), - CONSTRAINT FK_4 FOREIGN KEY ( id_job ) REFERENCES jobs ( id_job ) + CONSTRAINT FK_4 FOREIGN KEY ( id_event ) REFERENCES events ( id_event ) ); CREATE INDEX id_job_jobs_status_history ON jobs_status_history ( - id_job + id_event ); @@ -442,16 +448,18 @@ CREATE TABLE crm_contacts last_name text NOT NULL, created_at timestamp NOT NULL, modified_at timestamp NOT NULL, - id_job uuid NOT NULL, + origin text NOT NULL, + origin_id text NOT NULL, id_crm_user uuid NULL, + id_event uuid NOT NULL, CONSTRAINT PK_crm_contacts PRIMARY KEY ( id_crm_contact ), - CONSTRAINT job_id_crm_contact FOREIGN KEY ( id_job ) REFERENCES jobs ( id_job ), + CONSTRAINT job_id_crm_contact FOREIGN KEY ( id_event ) REFERENCES events ( id_event ), CONSTRAINT FK_23 FOREIGN KEY ( id_crm_user ) REFERENCES crm_users ( id_crm_user ) ); CREATE INDEX crm_contact_id_job ON crm_contacts ( - id_job + id_event ); CREATE INDEX FK_crm_contact_userID ON crm_contacts @@ -476,11 +484,11 @@ CREATE TABLE crm_companies number_of_employees bigint NULL, created_at timestamp NOT NULL, modified_at timestamp NOT NULL, - id_job uuid NOT NULL, id_crm_user uuid NULL, + id_event uuid NOT NULL, CONSTRAINT PK_crm_companies PRIMARY KEY ( id_crm_company ), CONSTRAINT FK_24 FOREIGN KEY ( id_crm_user ) REFERENCES crm_users ( id_crm_user ), - CONSTRAINT FK_13 FOREIGN KEY ( id_job ) REFERENCES jobs ( id_job ) + CONSTRAINT FK_13 FOREIGN KEY ( id_event ) REFERENCES events ( id_event ) ); CREATE INDEX FK_crm_company_crm_userID ON crm_companies @@ -490,7 +498,7 @@ CREATE INDEX FK_crm_company_crm_userID ON crm_companies CREATE INDEX FK_crm_company_jobID ON crm_companies ( - id_job + id_event ); diff --git a/packages/api/src/crm/README.md b/packages/api/src/crm/README.md new file mode 100644 index 000000000..aca53e9f2 --- /dev/null +++ b/packages/api/src/crm/README.md @@ -0,0 +1,25 @@ +# Panora - The Open Source Unified API Platform +## Supported Integrations + +Panora supports integration with the following objects across multiple platforms: + +| Panora | Hubspot | Pipedrive | Zoho CRM | Zendesk | Freshsales | +|-------------|-----------|-----------|-----------|-----------|------------| +| Contacts | ✔ | ✔ | ✔ | ✔ | ✔ | +| Deals | ❌ | ❌ | ❌ | ❌ | ❌ | +| Notes | ❌ | ❌ | ❌ | ❌ | ❌ | +| Engagement | ❌ | ❌ | ❌ | ❌ | ❌ | +| Tasks | ❌ | ❌ | ❌ | ❌ | ❌ | +| Users | ❌ | ❌ | ❌ | ❌ | ❌ | + +## Your CRM is missing? Or an object you need? + +1. **Click [here](https://panora.canny.io/integration-requests) to ask the Panora community for this integration.** +2. Browse existing requests to check if someone else has already suggested the CRM you have in mind. If so, you can upvote the existing request to show your support. +3. If your desired integration isn't already listed, click the "New Integration" button to submit a new integration request. Provide as much detail as possible about the CRM and the reasons for integration. +Thanks! 🙏 + + +## Want to build an integration? + +**Click [here](https://github.com/panoratech/Panora/blob/docs-crmcontact/CONTRIBUTING.md) to learn more!** \ No newline at end of file diff --git a/packages/api/src/crm/contact/README.md b/packages/api/src/crm/contact/README.md new file mode 100644 index 000000000..379440587 --- /dev/null +++ b/packages/api/src/crm/contact/README.md @@ -0,0 +1,22 @@ +# Panora Integrations + +| Panora | Unified Write | Passthrough Requests | Remote Data | Managed Webhooks | Webhooks Unified | +| ------------- | ------------- | -------------------- | ----------- | ----------------- | ---------------- | +| Hubspot | ✔️ | ✔️ | ✔️ | ❌ | ❌ | +| Zoho | ✔️ | ✔️ | ✔️ | ❌ | ❌ | +| Zendesk | ✔️ | ✔️ | ✔️ | ❌ | ❌ | +| Pipedrive | ✔️ | ✔️ | ✔️ | ❌ | ❌ | +| Freshsales | ✔️ | ✔️ | ✔️ | ❌ | ❌ | + + +## Can't find your CRM? + +1. **Click [here](https://panora.canny.io/integration-requests) to ask the Panora community for this integration.** +2. Browse existing requests to check if someone else has already suggested the CRM you have in mind. If so, you can upvote the existing request to show your support. +3. If your desired CRM isn't already listed, click the "New Post" button to submit a new integration request. Provide as much detail as possible about the CRM and the reasons for integration. +Thanks! 🙏 + + +## Want to add an integration? + +**Click [here](https://github.com/panoratech/Panora/blob/docs-crmcontact/CONTRIBUTING.md) to learn more!** \ No newline at end of file diff --git a/website-docs/.gitignore b/website-docs/.gitignore deleted file mode 100644 index b2d6de306..000000000 --- a/website-docs/.gitignore +++ /dev/null @@ -1,20 +0,0 @@ -# Dependencies -/node_modules - -# Production -/build - -# Generated files -.docusaurus -.cache-loader - -# Misc -.DS_Store -.env.local -.env.development.local -.env.test.local -.env.production.local - -npm-debug.log* -yarn-debug.log* -yarn-error.log* diff --git a/website-docs/README.md b/website-docs/README.md deleted file mode 100644 index fdc4b8d3b..000000000 --- a/website-docs/README.md +++ /dev/null @@ -1,41 +0,0 @@ -# Panora Documentation - - - -### Installation - -``` -pnpm install -``` - -### Build - -``` -pnpm run build -``` - -This command generates static content into the `build` directory and can be served using any static contents hosting service. - -### Local Development - -``` -pnpm run start -``` - -This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server. - -### Deployment - -Using SSH: - -``` -USE_SSH=true pnpm run deploy -``` - -Not using SSH: - -``` -GIT_USER= pnpm run deploy -``` - -If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch. diff --git a/website-docs/babel.config.js b/website-docs/babel.config.js deleted file mode 100644 index e00595dae..000000000 --- a/website-docs/babel.config.js +++ /dev/null @@ -1,3 +0,0 @@ -module.exports = { - presets: [require.resolve('@docusaurus/core/lib/babel/preset')], -}; diff --git a/website-docs/docs/Contribute/local-setup.mdx b/website-docs/docs/Contribute/local-setup.mdx deleted file mode 100644 index f3d547558..000000000 --- a/website-docs/docs/Contribute/local-setup.mdx +++ /dev/null @@ -1,16 +0,0 @@ ---- -title: Local Setup -sidebar_position: 0 ---- - -## Project structure - -The repository is structured as follows: - -``` -Panora -└───packages - └───api - └───sdk -└───website-docs // contains this documentation -``` diff --git a/website-docs/docs/Start/getting-started.mdx b/website-docs/docs/Start/getting-started.mdx deleted file mode 100644 index e5d7ef9c9..000000000 --- a/website-docs/docs/Start/getting-started.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: Getting Started -sidebar_position: 1 ---- - -import ThemedImage from "@theme/ThemedImage"; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; - -There are three ways for you to get started with Panora: - -### 1. Cloud - -The easiest way to quickly try the app is to signup on [panora.dev](https://panora.dev/). - -The signup is free. - -### 2. Local - -If you're a developer and would like to experiment or contribute to the app, you can install Panora on your local environment. Follow our [local setup](/contribute/local-setup) guide to get started. - -### 3. Self-hosting - -We provide [self-hosting options](/start/self-hosted) if you want greater control over your data and want to run the app on your own server. diff --git a/website-docs/docs/Start/self-hosted.mdx b/website-docs/docs/Start/self-hosted.mdx deleted file mode 100644 index 68c7d6629..000000000 --- a/website-docs/docs/Start/self-hosted.mdx +++ /dev/null @@ -1,6 +0,0 @@ ---- -title: Self-Hosting -sidebar_position: 2 ---- - -Right now, Docker containers are the only hosting option we support. diff --git a/website-docs/docs/index.mdx b/website-docs/docs/index.mdx deleted file mode 100644 index a08524bb8..000000000 --- a/website-docs/docs/index.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -id: homepage -sidebar_position: 0 -sidebar_class_name: display-none -title: Welcome -custom_edit_url: null ---- - -Panora is an Open Source iPaaS that provides unified APIs, tailored to your business needs. - -Our product makes it quick and easy for SaaS teams to ship customer-facing integrations between their product and others. - -We do so by providing a single API that abstracts similar tools your customer may use along your product behind a common data model. - -## Getting started - -There are three ways for you to get started with Panora: - -- **Cloud:** The fastest and easiest way to try the app (it's free) -- **Local:** If you're a developer and would like to experiment or contribute to the app -- **Self-hosting:** If you want greater control over your data and want to run the app on your own server - -See our [Getting Started](./start/getting-started/) guide to learn more. - -## Contributing - -Contributions are what makes the open source community such an amazing place. - -Code contributions through pull request are most welcome. See our [local setup guide](./contribute/local-setup) to get started. diff --git a/website-docs/docusaurus.config.js b/website-docs/docusaurus.config.js deleted file mode 100644 index e03905d5b..000000000 --- a/website-docs/docusaurus.config.js +++ /dev/null @@ -1,86 +0,0 @@ -// Note: type annotations allow type checking and IDEs autocompletion - -/* eslint-disable */ -const lightCodeTheme = require('prism-react-renderer/themes/github'); -const darkCodeTheme = require('prism-react-renderer/themes/dracula'); - -/** @type {import('@docusaurus/types').Config} */ -const config = { - title: 'Panora', - tagline: 'Dinosaurs are cool', - favicon: 'img/logo.png', - - // Set the production url of your site here - url: 'https://panoratech.github.io', - // Set the // pathname under which your site is served - // For GitHub pages deployment, it is often '//' - baseUrl: '/', - - // GitHub pages deployment config. - // If you aren't using GitHub pages, you don't need these. - organizationName: 'panoratech', // Usually your GitHub org/user name. - projectName: 'Panora', // Usually your repo name. - deploymentBranch: 'gh-pages', // default branch for GitHub Pages - - onBrokenLinks: 'throw', - onBrokenMarkdownLinks: 'warn', - - // Even if you don't use internalization, you can use this field to set useful - // metadata like html lang. For example, if your site is Chinese, you may want - // to replace "en" with "zh-Hans". - i18n: { - defaultLocale: 'en', - locales: ['en'], - }, - - presets: [ - [ - 'classic', - /** @type {import('@docusaurus/preset-classic').Options} */ - ({ - docs: { - breadcrumbs: false, - sidebarCollapsible: false, - routeBasePath: '/', - sidebarPath: require.resolve('./sidebars.js'), - // Please change this to your repo. - // Remove this to remove the "edit this page" links. - editUrl: 'https://github.com/panoratech/Panora/edit/main/docs/', - - }, - blog: false, - theme: { - customCss: require.resolve('./src/css/custom.css'), - }, - }), - ], - - ], - - themeConfig: - /** @type {import('@docusaurus/preset-classic').ThemeConfig} */ - ({ - // Replace with your project's social card - image: 'img/docusaurus-social-card.jpg', - navbar: { - title: 'Panora', - logo: { - alt: 'My Site Logo', - src: 'img/logo.png', - }, - items: [ - { - href: 'https://github.com/panoratech/Panora', - label: 'GitHub', - position: 'right', - }, - ], - }, - prism: { - theme: lightCodeTheme, - darkTheme: darkCodeTheme, - } - }), -}; - -module.exports = config; diff --git a/website-docs/package.json b/website-docs/package.json deleted file mode 100644 index 830a23f02..000000000 --- a/website-docs/package.json +++ /dev/null @@ -1,49 +0,0 @@ -{ - "name": "website-docs", - "version": "1.0.0", - "scripts": { - "docusaurus": "docusaurus", - "start": "docusaurus start", - "build": "docusaurus build", - "swizzle": "docusaurus swizzle", - "deploy": "GIT_USER=naelob docusaurus deploy", - "clear": "docusaurus clear", - "serve": "docusaurus serve", - "write-translations": "docusaurus write-translations", - "write-heading-ids": "docusaurus write-heading-ids", - "typecheck": "tsc" - }, - "dependencies": { - "@docusaurus/core": "2.4.3", - "@docusaurus/preset-classic": "2.4.3", - "@mdx-js/react": "^1.6.22", - "clsx": "^1.2.1", - "prism-react-renderer": "^1.3.5", - "react": "^17.0.2", - "react-dom": "^17.0.2" - }, - "devDependencies": { - "@docusaurus/module-type-aliases": "2.4.3", - "@tsconfig/docusaurus": "^1.0.7", - "@typescript-eslint/eslint-plugin": "^6.9.1", - "@typescript-eslint/parser": "^6.9.1", - "eslint": "^8.52.0", - "eslint-plugin-react": "^7.33.2", - "typescript": "^4.9.5" - }, - "browserslist": { - "production": [ - ">0.5%", - "not dead", - "not op_mini all" - ], - "development": [ - "last 1 chrome version", - "last 1 firefox version", - "last 1 safari version" - ] - }, - "engines": { - "node": ">=16.14" - } -} diff --git a/website-docs/sidebars.js b/website-docs/sidebars.js deleted file mode 100644 index 1d1b39cbd..000000000 --- a/website-docs/sidebars.js +++ /dev/null @@ -1,64 +0,0 @@ -/** - * Creating a sidebar enables you to: - - create an ordered group of docs - - render a sidebar for each doc of that group - - provide next/previous navigation - - The sidebars can be generated from the filesystem, or explicitly defined here. - - Create as many sidebars as you want. - */ - - -/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */ -/* eslint-disable */ -const sidebars = { - // By default, Docusaurus generates a sidebar from the docs folder structure - tutorialSidebar: [{type: 'autogenerated', dirName: '.'}], - docs: [ - { - type: 'doc', - id: 'homepage', - label: 'Welcome', - }, - { - type: 'category', - label: 'Start', - items: [ - { - type: 'doc', - id: 'Start/getting-started' - }, - { - type: 'doc', - id: 'Start/self-hosted' - }, - ], - }, - { - type: 'category', - label: 'Contribute', - items: [ - { - type: 'doc', - id: 'Contribute/local-setup' - }, - ], - }, - ], - - // But you can create a sidebar manually - /* - tutorialSidebar: [ - 'intro', - 'hello', - { - type: 'category', - label: 'Tutorial', - items: ['tutorial-basics/create-a-document'], - }, - ], - */ -}; - -module.exports = sidebars; diff --git a/website-docs/src/css/custom.css b/website-docs/src/css/custom.css deleted file mode 100644 index e64cf224f..000000000 --- a/website-docs/src/css/custom.css +++ /dev/null @@ -1,30 +0,0 @@ -/** - * Any CSS included here will be global. The classic template - * bundles Infima by default. Infima is a CSS framework designed to - * work well for content-centric websites. - */ - -/* You can override the default Infima variables here. */ -:root { - --ifm-color-primary: #e2af14; - --ifm-color-primary-dark: #29784c; - --ifm-color-primary-darker: #277148; - --ifm-color-primary-darkest: #205d3b; - --ifm-color-primary-light: #33925d; - --ifm-color-primary-lighter: #359962; - --ifm-color-primary-lightest: #3cad6e; - --ifm-code-font-size: 95%; - --docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.1); -} - -/* For readability concerns, you should choose a lighter palette in dark mode. */ -[data-theme="dark"] { - --ifm-color-primary: #dbdf52; - --ifm-color-primary-dark: #21af90; - --ifm-color-primary-darker: #1fa588; - --ifm-color-primary-darkest: #1a8870; - --ifm-color-primary-light: #29d5b0; - --ifm-color-primary-lighter: #32d8b4; - --ifm-color-primary-lightest: #4fddbf; - --docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.3); -} diff --git a/website-docs/static/.nojekyll b/website-docs/static/.nojekyll deleted file mode 100644 index e69de29bb..000000000 diff --git a/website-docs/static/img/docusaurus-social-card.jpg b/website-docs/static/img/docusaurus-social-card.jpg deleted file mode 100644 index ffcb44821..000000000 Binary files a/website-docs/static/img/docusaurus-social-card.jpg and /dev/null differ diff --git a/website-docs/static/img/docusaurus.png b/website-docs/static/img/docusaurus.png deleted file mode 100644 index f458149e3..000000000 Binary files a/website-docs/static/img/docusaurus.png and /dev/null differ diff --git a/website-docs/static/img/favicon.ico b/website-docs/static/img/favicon.ico deleted file mode 100644 index c01d54bcd..000000000 Binary files a/website-docs/static/img/favicon.ico and /dev/null differ diff --git a/website-docs/static/img/logo.png b/website-docs/static/img/logo.png deleted file mode 100644 index c7f5a60e2..000000000 Binary files a/website-docs/static/img/logo.png and /dev/null differ diff --git a/website-docs/static/img/logo.svg b/website-docs/static/img/logo.svg deleted file mode 100644 index 9db6d0d06..000000000 --- a/website-docs/static/img/logo.svg +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/website-docs/static/img/undraw_docusaurus_mountain.svg b/website-docs/static/img/undraw_docusaurus_mountain.svg deleted file mode 100644 index af961c49a..000000000 --- a/website-docs/static/img/undraw_docusaurus_mountain.svg +++ /dev/null @@ -1,171 +0,0 @@ - - Easy to Use - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/website-docs/static/img/undraw_docusaurus_react.svg b/website-docs/static/img/undraw_docusaurus_react.svg deleted file mode 100644 index 94b5cf08f..000000000 --- a/website-docs/static/img/undraw_docusaurus_react.svg +++ /dev/null @@ -1,170 +0,0 @@ - - Powered by React - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/website-docs/static/img/undraw_docusaurus_tree.svg b/website-docs/static/img/undraw_docusaurus_tree.svg deleted file mode 100644 index d9161d339..000000000 --- a/website-docs/static/img/undraw_docusaurus_tree.svg +++ /dev/null @@ -1,40 +0,0 @@ - - Focus on What Matters - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/website-docs/tsconfig.json b/website-docs/tsconfig.json deleted file mode 100644 index 6f4756980..000000000 --- a/website-docs/tsconfig.json +++ /dev/null @@ -1,7 +0,0 @@ -{ - // This file is not used in compilation. It is here just for a nice editor experience. - "extends": "@tsconfig/docusaurus/tsconfig.json", - "compilerOptions": { - "baseUrl": "." - } -}