diff --git a/.github/workflows/build-docs.yml b/.github/workflows/build-docs.yml new file mode 100644 index 0000000..de40bf2 --- /dev/null +++ b/.github/workflows/build-docs.yml @@ -0,0 +1,32 @@ +name: Build docs + +on: + pull_request: + branches: + - main + # Review gh actions docs if you want to further define triggers, paths, etc + # https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on + +permissions: + contents: read + +jobs: + test-deploy: + name: Test deployment + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + with: + fetch-depth: 0 + - uses: actions/setup-node@v4 + with: + node-version: 20 + cache: npm + + - name: Install dependencies + run: npm ci + working-directory: docs + + - name: Test build website + run: npm run build + working-directory: docs diff --git a/README.md b/README.md index 310367b..0bafe66 100644 --- a/README.md +++ b/README.md @@ -5,8 +5,6 @@ Pulse Editor > [!IMPORTANT] > Pulse Editor is still in its early development stage. We are trying hard to make sure everything works as expected for all different platforms. See [Beta Release Roadmap](#beta-release-roadmap) below. - -

Pulse Editor

@@ -15,9 +13,11 @@ Pulse Editor [![Discord](https://img.shields.io/badge/Discord-%235865F2.svg?style=for-the-badge&logo=discord&logoColor=white)](https://discord.gg/s6J54HFxQp) [![Licence](https://img.shields.io/github/license/Ileriayo/markdown-badges?style=for-the-badge)](./LICENSE) + # Table of Contents + - [Table of Contents](#table-of-contents) @@ -26,7 +26,7 @@ Pulse Editor - [Major Beta Release 1 (June 2025):](#major-beta-release-1-june-2025) - [Major Beta Release 2 (planned for 2025 Q3)](#major-beta-release-2-planned-for-2025-q3) - [Major Beta Release 3 (planned for 2025 Q4)](#major-beta-release-3-planned-for-2025-q4) -- [Documentation (WIP)](#documentation-wip) +- [Documentation and Guide](#documentation-and-guide) - [Getting Started -- User Guide](#getting-started----user-guide) - [Web Client](#web-client) - [Mobile Client](#mobile-client) @@ -47,17 +47,21 @@ Pulse Editor # Introduction + Pulse Editor is a cross-platform tool built to make AI-powered creation and development feel intuitive and seamless. # Beta Release Roadmap -🎉🎉Pulse Editor is now in beta. + +🎉🎉Pulse Editor is now in beta. We plan to have 2-3 major beta release stages before we reach a stable release version. ### Major Beta Release 1 (June 2025): + Pulse Editor is now available on Android and Desktop (tested for Windows, needs more testing for Linux and MacOS). Pulse Editor Marketplace now is available for editor users. Simply download Pulse Editor, and view all available extensions in the extension page. You can also browser and search extensions in [Marketplace Web (WIP)](https://pulse-editor.com/marketplace). As for now, the following extensions are available: + - (Official) [Pulse Editor Code View (MIT)](https://github.com/ClayPulse/pulse-editor-code-view) - (Official) [Pulse Editor Terminal (MIT)](https://github.com/ClayPulse/pulse-editor-terminal) - (Official) [Pulse Editor Image Editor (MIT)](https://github.com/Shellishack/pulse-editor-image-editor) @@ -67,9 +71,10 @@ Pulse Editor Marketplace Developer Access is now open for application. If you'd Even if you haven't got access to publish your extensions to the marketplace, you can still explore Pulse Editor platform by developing your own extensions locally. This is a great opportunity to get an early look at Pulse Editor and start experimenting with its capabilities! See [Extension Development](#pulse-editor-extension-development) below. - ### Major Beta Release 2 (planned for 2025 Q3) + Planned items: + - Documentation - Support for web - Support remote Pulse Editor instance access @@ -79,102 +84,136 @@ Planned items: ~~Coming Soon: [Making 100 Extension Apps Challenge](https://github.com/shellishack)~~ ### Major Beta Release 3 (planned for 2025 Q4) + ... (WIP) -# Documentation (WIP) -The documentation will be available at https://docs.pulse-editor.com. You can find documentation repository [here](https://github.com/ClayPulse/docs). +# Documentation and Guide + +The documentation and user guide will be available at https://docs.pulse-editor.com. For documentation contributors, the docs source repository is located [here](docs/). # Getting Started -- User Guide + ## Web Client -There is a web deployment at https://editor.claypulse.ai + +There is a web deployment at https://web.pulse-editor.com For detailed web user guide, check out [Web User Guide](web/README.md) + ## Mobile Client + Android client is available in release page. ->Current we only support Android, although it is technically possible to have an iOS build (see developer guide below). + +> Current we only support Android, although it is technically possible to have an iOS build (see developer guide below). For detailed mobile user guide, check out [Mobile User Guide](mobile/README.md) + ## Desktop Client + Linux, MacOS, Windows clients are available in release page. + > [!NOTE] > Only Windows is tested in alpha release. For detailed desktop user guide, check out [Desktop User Guide](desktop/README.md) + ## VSCode Extension + A VSCode Webview Extension with limited features is available [here](https://marketplace.visualstudio.com/items?itemName=shellishack.pulse-editor). For detailed VSCode extension user guide, check out [VSCode Extension User Guide](vscode-extension/README.md) - # Getting Started -- Development Guide + ## Recommended Nodejs version + Nodejs 20 + ## Install dependencies + You can install dependencies for all workspaces using + ``` npm i ``` + Or, for a specific workspace. e.g. for web: + ``` npm i --workspace=web ``` ## Install dependencies (desktop native modules) + When dependencies in `desktop/`, use Electron's nodejs instead of local nodejs. Make sure you have installed necessary build tools. + ### For Windows + Nodejs Windows Installer should already include windows-build-tools. In addition, make sure [Windows SDK](https://developer.microsoft.com/en-us/windows/downloads/windows-10-sdk) is also available: ### For Linux + ``` sudo apt install -y make python build-essential ``` Then you can rebuild native dependencies in `desktop/` using. + ``` cd desktop npm run rebuild-native ``` + Electron may warn you need NODE_MODULE_VERSION xxx. If you have electron@35.0.2 installed (check desktop/package.json), you can run: + ``` electron-rebuild -v 35.0.2 ``` Start development: + ``` npm run desktop-dev ``` + Build production release: + ``` npm run desktop-build ``` - ## Web Development -Pulse Editor uses Next.js as the frontend (and backend -- TBD). -You can get started with local development by running: + +Pulse Editor uses Next.js as the frontend (and backend -- TBD). +You can get started with local development by running: + ```bash npm run web-dev ``` ## Mobile Development + Pulse Editor uses Capacitor.js to create mobile apps on Android and iOS. To develop mobile app locally, try the following. Start development: + ``` npm run android-dev ``` Build production release + ```bash # Production npm run android-build ``` ## Desktop Development + Pulse Editor uses Electron.js to create desktop apps on Windows, Mac and Linux. To develop desktop app locally, run: + ```bash # Development npm run desktop-dev @@ -185,6 +224,7 @@ npm run desktop-build If you run `npm run desktop-build` for a production build, you can find an executable file inside `build/desktop`. ## VSCode Extension Development + > [!warning] > The code in `vscode-extension` might be out of date, as it was made for an Alpha Demo. > Support for using Pulse Editor as an extension in VSCode might be discontinued, or get simply replaced with a webview. @@ -194,9 +234,11 @@ Pulse Editor uses VSCode Webview API to create a VSCode Extension. To develop VS Note that you will also need to run the Nextjs server locally during development. ## Pulse Editor Extension Development + Pulse Editor uses [Modular Federation](https://module-federation.io/) to deliver its modular extensions. For guides on how to start developing and using extensions locally, check out our [React template repository](https://github.com/ClayPulse/pulse-editor-extension-template). Some of our official extensions are also open-source. Feel free to take examples from them and/or contribute to them. + - [Pulse Editor Code View](https://github.com/ClayPulse/pulse-editor-code-view) - [Pulse Editor Terminal](https://github.com/ClayPulse/pulse-editor-terminal) diff --git a/desktop/README.md b/desktop/README.md deleted file mode 100644 index e0cc58d..0000000 --- a/desktop/README.md +++ /dev/null @@ -1,42 +0,0 @@ -# Desktop User Guide -### Installation - -Linux, MacOS, and Windows clients are available for download in our GitHub release page. - -(Only Windows is tested in the alpha release) - -You must then configure settings in the app. Specifically, to use Voice Chat, you need to have all STT, LLM, TTS configured; to only use Agentic Chat Terminal or Code Completion, you need to configure LLM. - -| Modality | Supported Provider | -| --- | --- | -| STT | OpenAI | -| LLM | OpenAI | -| TTS | OpenAI, ElevenLabs | - -(For TTS, you need to enter a voice name or voice ID which you can find from your provider. e.g. “alloy” for OpenAI TTS1, “Maltida” for ElevenLabs.) - -### Open File - -Click the menu at top-left corner, then click either “new file” to get an empty file or “open file” to select one from your file system. - -### Voice Chat - -(Make sure you have configured all STT, LLM, TTS providers and API keys) - -Click the microphone icon in the bottom toolbar, and grant permission if prompted. Then start chatting using voice. Any code changes will be made in the code view once the request completes. - -### Drawing Gesture - -Click the pen icon in the bottom toolbar, and start drawing using your cursor. If you wish to restart, simply toggle off and on the pen tool again. - -### Agentic Chat Terminal - -(Make sure you have configured LLM provider and API key) - -Click the “Open Chat View” icon in the bottom toolbar. Then select your desire agent, or define your own by clicking the plus icon. Next, start chatting by typing in text in the input box. - -### Code Completion - -(Make sure you have configured LLM provider and API key) - -Type anything in an open file, then a suggestion would become available in grey text. Press tab key to accept changes, or keep typing to refresh new suggest. \ No newline at end of file diff --git a/docs/docs/api-reference/index.md b/docs/docs/api-reference/index.md new file mode 100644 index 0000000..6834b91 --- /dev/null +++ b/docs/docs/api-reference/index.md @@ -0,0 +1,6 @@ +--- +sidebar_position: 1 +--- + +# Introduction +This is \ No newline at end of file diff --git a/docs/docs/guide/develop-extensions/_category_.json b/docs/docs/guide/develop-extensions/_category_.json new file mode 100644 index 0000000..20a6579 --- /dev/null +++ b/docs/docs/guide/develop-extensions/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "Development Guide", + "position": 6 +} \ No newline at end of file diff --git a/docs/docs/guide/develop-extensions/cli.md b/docs/docs/guide/develop-extensions/cli.md new file mode 100644 index 0000000..14c8fe3 --- /dev/null +++ b/docs/docs/guide/develop-extensions/cli.md @@ -0,0 +1,20 @@ +--- +sidebar_position: 1 +--- + +# Pulse Editor CLI + +## Installation +```bash +npx -g install @pulse-editor/cli +``` + +## Create extension project +```bash +pulse create +``` + +## Publish extension to marketplace +```bash +pulse publish +``` \ No newline at end of file diff --git a/docs/docs/guide/develop-extensions/index.md b/docs/docs/guide/develop-extensions/index.md new file mode 100644 index 0000000..768a3af --- /dev/null +++ b/docs/docs/guide/develop-extensions/index.md @@ -0,0 +1,18 @@ +# Develop Extensions + +## Choose your framework + +Pulse Editor uses [Module Federation](https://module-federation.io/guide/start/) to enable extension system. Thanks to the [Micro-Frontend](https://en.wikipedia.org/wiki/Micro_frontend) architecture of [Module Federation](https://module-federation.io/guide/start/), you can (technically) use any frontend web development framework to develop your extensions. + +For you to get started quickly, we offer starter templates for the following frameworks + +- React +- More to come! + +## Use Pulse Editor CLI + +You can use Pulse Editor CLI tool to manage developer credentials, create projects, and publish extensions, etc. Check out the [cli guide](/docs/guide/develop-extensions/cli). + +import DocCardList from '@theme/DocCardList'; + + diff --git a/docs/docs/guide/develop-extensions/react/_category_.json b/docs/docs/guide/develop-extensions/react/_category_.json new file mode 100644 index 0000000..ef302b8 --- /dev/null +++ b/docs/docs/guide/develop-extensions/react/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "Develop Extensions with React", + "position": 2 +} \ No newline at end of file diff --git a/docs/docs/guide/develop-extensions/react/index.md b/docs/docs/guide/develop-extensions/react/index.md new file mode 100644 index 0000000..90dcc5f --- /dev/null +++ b/docs/docs/guide/develop-extensions/react/index.md @@ -0,0 +1 @@ +# React \ No newline at end of file diff --git a/docs/docs/guide/develop-extensions/react/react-template.md b/docs/docs/guide/develop-extensions/react/react-template.md new file mode 100644 index 0000000..31a87e8 --- /dev/null +++ b/docs/docs/guide/develop-extensions/react/react-template.md @@ -0,0 +1 @@ +# React Starter Template \ No newline at end of file diff --git a/docs/docs/guide/index.md b/docs/docs/guide/index.md new file mode 100644 index 0000000..0957ed0 --- /dev/null +++ b/docs/docs/guide/index.md @@ -0,0 +1,41 @@ +--- +sidebar_position: 1 +--- + +# Introduction + +Welcome to Pulse Editor's Documentation. + +## About Pulse Editor + +Pulse Editor is your creative platform — modular, AI-enhanced, and ready for any device. + +From idea to execution, creators and developers can create, build, and automate using a growing library of tools and extensions from the Pulse Editor Marketplace. + +Whether you're editing text, generating images, coding apps, or producing videos, Pulse Editor adapts to your workflow — on desktop, mobile, or web. + +Powered by an AI-native foundation, Pulse offers intelligent planning, context-aware suggestions, real-time AI collaboration, and autonomous task execution — making creativity faster, smarter, and more connected than ever. + +## Why developing a creative app platform? + +Creative software hasn't kept pace with how people work—or with what AI makes possible. +Despite rapid progress in AI, today's tools and ecosystems remain stuck in outdated paradigms. Creators and developers face two major roadblocks: + +1. **Creative workflows are fragmented and disconnected** + Most creative tools operate in isolation, with little to no collaboration across apps. Yet this isn’t just a product issue—it’s systemic. Traditional software distribution and app stores are designed around individual, siloed apps that don’t communicate, forcing users to manually stitch together fragmented workflows. + +2. **Existing ecosystems weren’t built for AI—and now they’re struggling to adapt** + Most leading tools were built on heavy, legacy codebases—long before AI was a factor. This makes it hard to retrofit intelligent, cross-platform capabilities. For example, AI coding tools like VSCode, Cursor, and Windsurf share the same decade old codebase and the same struggle of being desktop-bound. + +**What’s missing:** +A modern, AI-native creative app platform that connects the dots—providing smart planning, creating, and executing across disciplines, so users can focus on ideas. + +## Get Started with Pulse Editor + +In this guide, you can learn and find useful information about Pulse Editor core, extensions, marketplace, and developer libraries. + +To get quick started, you can check the following pages. + +import DocCardList from '@theme/DocCardList'; + + diff --git a/docs/docs/guide/installation/_category_.json b/docs/docs/guide/installation/_category_.json new file mode 100644 index 0000000..8e202f6 --- /dev/null +++ b/docs/docs/guide/installation/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "Installation", + "position": 2 +} \ No newline at end of file diff --git a/docs/docs/guide/installation/android.md b/docs/docs/guide/installation/android.md new file mode 100644 index 0000000..c5fa9bf --- /dev/null +++ b/docs/docs/guide/installation/android.md @@ -0,0 +1,11 @@ +# Android + +## Use Pulse Editor on Android phone + +Download the `.apk` file from our [GitHub repo](https://github.com/ClayPulse/pulse-editor/releases). + +:::warning + +🚧 Coming soon: Installation via Play Store. + +::: diff --git a/docs/docs/guide/installation/index.md b/docs/docs/guide/installation/index.md new file mode 100644 index 0000000..3244d52 --- /dev/null +++ b/docs/docs/guide/installation/index.md @@ -0,0 +1,9 @@ +# Installation + +## Download latest builds + +The latest release builds are available on our [GitHub repo](https://github.com/ClayPulse/pulse-editor/releases). Please refer to the following sections for the platform that you use. + +import DocCardList from '@theme/DocCardList'; + + diff --git a/docs/docs/guide/installation/ios.md b/docs/docs/guide/installation/ios.md new file mode 100644 index 0000000..a9c2ce8 --- /dev/null +++ b/docs/docs/guide/installation/ios.md @@ -0,0 +1,9 @@ +# iOS (Coming Soon) + +## Use Pulse Editor on iPhone + +:::warning + +🚧 Coming soon. + +::: diff --git a/docs/docs/guide/installation/linux.md b/docs/docs/guide/installation/linux.md new file mode 100644 index 0000000..d4b8993 --- /dev/null +++ b/docs/docs/guide/installation/linux.md @@ -0,0 +1,11 @@ +# Linux (Experimental) + +## Use Pulse Editor on Linux + +Download the `.zip` file for Linux from our [GitHub repo](https://github.com/ClayPulse/pulse-editor/releases). + +:::warning + +🚧 The Linux version is not fully tested as of this early stage. + +::: diff --git a/docs/docs/guide/installation/macos.md b/docs/docs/guide/installation/macos.md new file mode 100644 index 0000000..2d9212c --- /dev/null +++ b/docs/docs/guide/installation/macos.md @@ -0,0 +1,11 @@ +# MacOS (Experimental) + +## Use Pulse Editor on MacOS + +Download the `.zip` file for MacOS from our [GitHub repo](https://github.com/ClayPulse/pulse-editor/releases). + +:::warning + +🚧 The MacOS version is not fully tested as of this early stage. + +::: diff --git a/docs/docs/guide/installation/web.md b/docs/docs/guide/installation/web.md new file mode 100644 index 0000000..27583ea --- /dev/null +++ b/docs/docs/guide/installation/web.md @@ -0,0 +1,11 @@ +# Web (Coming Soon) + +## Use Pulse Editor in your browser + +No installation required. Open [Pulse Editor Web](https://web.pulse-editor.com) in browser to get started. + +:::warning + +🚧 Coming soon: Web Editor is under construction. + +::: diff --git a/docs/docs/guide/installation/windows.md b/docs/docs/guide/installation/windows.md new file mode 100644 index 0000000..58300bd --- /dev/null +++ b/docs/docs/guide/installation/windows.md @@ -0,0 +1,5 @@ +# Windows + +## Use Pulse Editor on Windows + +Download the `.zip` file for Windows from our [GitHub repo](https://github.com/ClayPulse/pulse-editor/releases). diff --git a/docs/docs/guide/pulse-editor-app/_category_.json b/docs/docs/guide/pulse-editor-app/_category_.json new file mode 100644 index 0000000..3b792ab --- /dev/null +++ b/docs/docs/guide/pulse-editor-app/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "Pulse Editor App", + "position": 4 +} diff --git a/docs/docs/guide/pulse-editor-app/concepts.md b/docs/docs/guide/pulse-editor-app/concepts.md new file mode 100644 index 0000000..74d42e1 --- /dev/null +++ b/docs/docs/guide/pulse-editor-app/concepts.md @@ -0,0 +1 @@ +# Concepts diff --git a/docs/docs/guide/pulse-editor-app/extension-system/index.md b/docs/docs/guide/pulse-editor-app/extension-system/index.md new file mode 100644 index 0000000..fad7923 --- /dev/null +++ b/docs/docs/guide/pulse-editor-app/extension-system/index.md @@ -0,0 +1 @@ +# Extension System \ No newline at end of file diff --git a/docs/docs/guide/pulse-editor-app/index.md b/docs/docs/guide/pulse-editor-app/index.md new file mode 100644 index 0000000..9f92fdc --- /dev/null +++ b/docs/docs/guide/pulse-editor-app/index.md @@ -0,0 +1,7 @@ +# Pulse Editor App + +## Learn about core concepts of Pulse Editor App + +import DocCardList from '@theme/DocCardList'; + + diff --git a/docs/docs/guide/quick-start/_category_.json b/docs/docs/guide/quick-start/_category_.json new file mode 100644 index 0000000..c9c1c74 --- /dev/null +++ b/docs/docs/guide/quick-start/_category_.json @@ -0,0 +1,8 @@ +{ + "label": "Quick Start", + "position": 3, + "link": { + "type": "generated-index", + "description": "Get started with Pulse Editor in just a few steps." + } +} \ No newline at end of file diff --git a/docs/docs/guide/quick-start/configure-ai-agents.md b/docs/docs/guide/quick-start/configure-ai-agents.md new file mode 100644 index 0000000..5e1f31d --- /dev/null +++ b/docs/docs/guide/quick-start/configure-ai-agents.md @@ -0,0 +1,5 @@ +--- +sidebar_position: 3 +--- + +# Configure AI Agents diff --git a/docs/docs/guide/quick-start/how-to-use-extensions.md b/docs/docs/guide/quick-start/how-to-use-extensions.md new file mode 100644 index 0000000..82c71cd --- /dev/null +++ b/docs/docs/guide/quick-start/how-to-use-extensions.md @@ -0,0 +1,13 @@ +--- +sidebar_position: 2 +--- + +# How to Use Extensions + +## Install extensions from marketplace + +Pulse Editor is a modular, extensible creative platform that allows users to install any extension they need for their creative workflow, and enables extension developers to publish extensions and have a chance to earn. + +:::info +Pulse Editor provides a set of SDK libraries for extension developers. If you are interested in building and publishing extension apps to Pulse Editor Marketplace, check out the [extension developer guide](/docs/guide/develop-extensions). +::: diff --git a/docs/docs/guide/quick-start/set-up-pulse-editor.md b/docs/docs/guide/quick-start/set-up-pulse-editor.md new file mode 100644 index 0000000..b6463bd --- /dev/null +++ b/docs/docs/guide/quick-start/set-up-pulse-editor.md @@ -0,0 +1,34 @@ +--- +sidebar_position: 1 +--- + +# Set up Pulse Editor + +## Configuring AI models in Pulse Editor + +Pulse Editor is an all-in-one AI creative platform that allows you to create workflows using countless many extension apps from our marketplace. With Pulse Editor, you can manage all AI models in one place at the platform level. There are mainly two ways that AI models are used during your creation process. + +1. The Pulse Editor Creative AI can interact with extensions on your behalf. Most extensions expose some commands that Pulse Editor Creative AI can understand. After chatting or talking with the user, Pulse Editor Creative AI may decide to run these commands to help user with some certain tasks. +2. Some extensions may have features that use AI models (e.g. Code Agent from Pulse Editor Code needs to have access to a LLM). Pulse Editor core exposes unified AI calling APIs to these extensions. + +For both scenarios, you can choose to either bring your own AI model API keys from providers, or subscribe to [Pulse Editor's plans (Coming Soon)](https://pulse-editor.com/pricing) to use our managed AI services. + +:::info +You can also choose not to set up AI if you do not need to use Pulse Editor Creative AI and installed extensions do not call AI models. There are still many non-AI functions from all kinds of extensions that might be helpful for your project. Jump to [next step](/docs/guide/quick-start/how-to-use-extensions) to get started using extensions right away. +::: + +Before proceeding, make sure you have installed Pulse Editor on your desired platform by following [installation guide](/docs/guide/installation/). You can start configuring Pulse Editor's AI settings on your device with the following options to fully unlock the power of Pulse Editor AI. + +## Bring your own AI API keys + +1. Open Pulse Editor on your device. +2. Go to settings. +3. Scroll to AI settings section, and find the modality that you need. +E.g. you need to configure LLM settings if you need to run LLM agents. +4. Choose provider, model name, and other settings needed for that particular provider/model. + +:::warning +🚧 There are only limited providers and models that we support at this moment. In the future, we plan to enable more providers and arbitrary models from that provider. +::: + +## Use Pulse Editor AI credits subscription (WIP) diff --git a/docs/docs/intro.md b/docs/docs/intro.md deleted file mode 100644 index 45e8604..0000000 --- a/docs/docs/intro.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Tutorial Intro - -Let's discover **Docusaurus in less than 5 minutes**. - -## Getting Started - -Get started by **creating a new site**. - -Or **try Docusaurus immediately** with **[docusaurus.new](https://docusaurus.new)**. - -### What you'll need - -- [Node.js](https://nodejs.org/en/download/) version 18.0 or above: - - When installing Node.js, you are recommended to check all checkboxes related to dependencies. - -## Generate a new site - -Generate a new Docusaurus site using the **classic template**. - -The classic template will automatically be added to your project after you run the command: - -```bash -npm init docusaurus@latest my-website classic -``` - -You can type this command into Command Prompt, Powershell, Terminal, or any other integrated terminal of your code editor. - -The command also installs all necessary dependencies you need to run Docusaurus. - -## Start your site - -Run the development server: - -```bash -cd my-website -npm run start -``` - -The `cd` command changes the directory you're working with. In order to work with your newly created Docusaurus site, you'll need to navigate the terminal there. - -The `npm run start` command builds your website locally and serves it through a development server, ready for you to view at http://localhost:3000/. - -Open `docs/intro.md` (this page) and edit some lines: the site **reloads automatically** and displays your changes. diff --git a/docs/docs/tutorial-basics/_category_.json b/docs/docs/tutorial-basics/_category_.json deleted file mode 100644 index 2e6db55..0000000 --- a/docs/docs/tutorial-basics/_category_.json +++ /dev/null @@ -1,8 +0,0 @@ -{ - "label": "Tutorial - Basics", - "position": 2, - "link": { - "type": "generated-index", - "description": "5 minutes to learn the most important Docusaurus concepts." - } -} diff --git a/docs/docs/tutorial-basics/congratulations.md b/docs/docs/tutorial-basics/congratulations.md deleted file mode 100644 index 04771a0..0000000 --- a/docs/docs/tutorial-basics/congratulations.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -sidebar_position: 6 ---- - -# Congratulations! - -You have just learned the **basics of Docusaurus** and made some changes to the **initial template**. - -Docusaurus has **much more to offer**! - -Have **5 more minutes**? Take a look at **[versioning](../tutorial-extras/manage-docs-versions.md)** and **[i18n](../tutorial-extras/translate-your-site.md)**. - -Anything **unclear** or **buggy** in this tutorial? [Please report it!](https://github.com/facebook/docusaurus/discussions/4610) - -## What's next? - -- Read the [official documentation](https://docusaurus.io/) -- Modify your site configuration with [`docusaurus.config.js`](https://docusaurus.io/docs/api/docusaurus-config) -- Add navbar and footer items with [`themeConfig`](https://docusaurus.io/docs/api/themes/configuration) -- Add a custom [Design and Layout](https://docusaurus.io/docs/styling-layout) -- Add a [search bar](https://docusaurus.io/docs/search) -- Find inspirations in the [Docusaurus showcase](https://docusaurus.io/showcase) -- Get involved in the [Docusaurus Community](https://docusaurus.io/community/support) diff --git a/docs/docs/tutorial-basics/create-a-blog-post.md b/docs/docs/tutorial-basics/create-a-blog-post.md deleted file mode 100644 index 550ae17..0000000 --- a/docs/docs/tutorial-basics/create-a-blog-post.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Create a Blog Post - -Docusaurus creates a **page for each blog post**, but also a **blog index page**, a **tag system**, an **RSS** feed... - -## Create your first Post - -Create a file at `blog/2021-02-28-greetings.md`: - -```md title="blog/2021-02-28-greetings.md" ---- -slug: greetings -title: Greetings! -authors: - - name: Joel Marcey - title: Co-creator of Docusaurus 1 - url: https://github.com/JoelMarcey - image_url: https://github.com/JoelMarcey.png - - name: Sébastien Lorber - title: Docusaurus maintainer - url: https://sebastienlorber.com - image_url: https://github.com/slorber.png -tags: [greetings] ---- - -Congratulations, you have made your first post! - -Feel free to play around and edit this post as much as you like. -``` - -A new blog post is now available at [http://localhost:3000/blog/greetings](http://localhost:3000/blog/greetings). diff --git a/docs/docs/tutorial-basics/create-a-document.md b/docs/docs/tutorial-basics/create-a-document.md deleted file mode 100644 index c22fe29..0000000 --- a/docs/docs/tutorial-basics/create-a-document.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Create a Document - -Documents are **groups of pages** connected through: - -- a **sidebar** -- **previous/next navigation** -- **versioning** - -## Create your first Doc - -Create a Markdown file at `docs/hello.md`: - -```md title="docs/hello.md" -# Hello - -This is my **first Docusaurus document**! -``` - -A new document is now available at [http://localhost:3000/docs/hello](http://localhost:3000/docs/hello). - -## Configure the Sidebar - -Docusaurus automatically **creates a sidebar** from the `docs` folder. - -Add metadata to customize the sidebar label and position: - -```md title="docs/hello.md" {1-4} ---- -sidebar_label: 'Hi!' -sidebar_position: 3 ---- - -# Hello - -This is my **first Docusaurus document**! -``` - -It is also possible to create your sidebar explicitly in `sidebars.js`: - -```js title="sidebars.js" -export default { - tutorialSidebar: [ - 'intro', - // highlight-next-line - 'hello', - { - type: 'category', - label: 'Tutorial', - items: ['tutorial-basics/create-a-document'], - }, - ], -}; -``` diff --git a/docs/docs/tutorial-basics/create-a-page.md b/docs/docs/tutorial-basics/create-a-page.md deleted file mode 100644 index 20e2ac3..0000000 --- a/docs/docs/tutorial-basics/create-a-page.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Create a Page - -Add **Markdown or React** files to `src/pages` to create a **standalone page**: - -- `src/pages/index.js` → `localhost:3000/` -- `src/pages/foo.md` → `localhost:3000/foo` -- `src/pages/foo/bar.js` → `localhost:3000/foo/bar` - -## Create your first React Page - -Create a file at `src/pages/my-react-page.js`: - -```jsx title="src/pages/my-react-page.js" -import React from 'react'; -import Layout from '@theme/Layout'; - -export default function MyReactPage() { - return ( - -

My React page

-

This is a React page

- - ); -} -``` - -A new page is now available at [http://localhost:3000/my-react-page](http://localhost:3000/my-react-page). - -## Create your first Markdown Page - -Create a file at `src/pages/my-markdown-page.md`: - -```mdx title="src/pages/my-markdown-page.md" -# My Markdown page - -This is a Markdown page -``` - -A new page is now available at [http://localhost:3000/my-markdown-page](http://localhost:3000/my-markdown-page). diff --git a/docs/docs/tutorial-basics/deploy-your-site.md b/docs/docs/tutorial-basics/deploy-your-site.md deleted file mode 100644 index 1c50ee0..0000000 --- a/docs/docs/tutorial-basics/deploy-your-site.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -sidebar_position: 5 ---- - -# Deploy your site - -Docusaurus is a **static-site-generator** (also called **[Jamstack](https://jamstack.org/)**). - -It builds your site as simple **static HTML, JavaScript and CSS files**. - -## Build your site - -Build your site **for production**: - -```bash -npm run build -``` - -The static files are generated in the `build` folder. - -## Deploy your site - -Test your production build locally: - -```bash -npm run serve -``` - -The `build` folder is now served at [http://localhost:3000/](http://localhost:3000/). - -You can now deploy the `build` folder **almost anywhere** easily, **for free** or very small cost (read the **[Deployment Guide](https://docusaurus.io/docs/deployment)**). diff --git a/docs/docs/tutorial-basics/markdown-features.mdx b/docs/docs/tutorial-basics/markdown-features.mdx deleted file mode 100644 index 35e0082..0000000 --- a/docs/docs/tutorial-basics/markdown-features.mdx +++ /dev/null @@ -1,152 +0,0 @@ ---- -sidebar_position: 4 ---- - -# Markdown Features - -Docusaurus supports **[Markdown](https://daringfireball.net/projects/markdown/syntax)** and a few **additional features**. - -## Front Matter - -Markdown documents have metadata at the top called [Front Matter](https://jekyllrb.com/docs/front-matter/): - -```text title="my-doc.md" -// highlight-start ---- -id: my-doc-id -title: My document title -description: My document description -slug: /my-custom-url ---- -// highlight-end - -## Markdown heading - -Markdown text with [links](./hello.md) -``` - -## Links - -Regular Markdown links are supported, using url paths or relative file paths. - -```md -Let's see how to [Create a page](/create-a-page). -``` - -```md -Let's see how to [Create a page](./create-a-page.md). -``` - -**Result:** Let's see how to [Create a page](./create-a-page.md). - -## Images - -Regular Markdown images are supported. - -You can use absolute paths to reference images in the static directory (`static/img/docusaurus.png`): - -```md -![Docusaurus logo](/img/docusaurus.png) -``` - -![Docusaurus logo](/img/docusaurus.png) - -You can reference images relative to the current file as well. This is particularly useful to colocate images close to the Markdown files using them: - -```md -![Docusaurus logo](./img/docusaurus.png) -``` - -## Code Blocks - -Markdown code blocks are supported with Syntax highlighting. - -````md -```jsx title="src/components/HelloDocusaurus.js" -function HelloDocusaurus() { - return

Hello, Docusaurus!

; -} -``` -```` - -```jsx title="src/components/HelloDocusaurus.js" -function HelloDocusaurus() { - return

Hello, Docusaurus!

; -} -``` - -## Admonitions - -Docusaurus has a special syntax to create admonitions and callouts: - -```md -:::tip My tip - -Use this awesome feature option - -::: - -:::danger Take care - -This action is dangerous - -::: -``` - -:::tip My tip - -Use this awesome feature option - -::: - -:::danger Take care - -This action is dangerous - -::: - -## MDX and React Components - -[MDX](https://mdxjs.com/) can make your documentation more **interactive** and allows using any **React components inside Markdown**: - -```jsx -export const Highlight = ({children, color}) => ( - { - alert(`You clicked the color ${color} with label ${children}`) - }}> - {children} - -); - -This is Docusaurus green ! - -This is Facebook blue ! -``` - -export const Highlight = ({children, color}) => ( - { - alert(`You clicked the color ${color} with label ${children}`); - }}> - {children} - -); - -This is Docusaurus green ! - -This is Facebook blue ! diff --git a/docs/docs/tutorial-extras/_category_.json b/docs/docs/tutorial-extras/_category_.json deleted file mode 100644 index a8ffcc1..0000000 --- a/docs/docs/tutorial-extras/_category_.json +++ /dev/null @@ -1,7 +0,0 @@ -{ - "label": "Tutorial - Extras", - "position": 3, - "link": { - "type": "generated-index" - } -} diff --git a/docs/docs/tutorial-extras/img/docsVersionDropdown.png b/docs/docs/tutorial-extras/img/docsVersionDropdown.png deleted file mode 100644 index 97e4164..0000000 Binary files a/docs/docs/tutorial-extras/img/docsVersionDropdown.png and /dev/null differ diff --git a/docs/docs/tutorial-extras/img/localeDropdown.png b/docs/docs/tutorial-extras/img/localeDropdown.png deleted file mode 100644 index e257edc..0000000 Binary files a/docs/docs/tutorial-extras/img/localeDropdown.png and /dev/null differ diff --git a/docs/docs/tutorial-extras/manage-docs-versions.md b/docs/docs/tutorial-extras/manage-docs-versions.md deleted file mode 100644 index ccda0b9..0000000 --- a/docs/docs/tutorial-extras/manage-docs-versions.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Manage Docs Versions - -Docusaurus can manage multiple versions of your docs. - -## Create a docs version - -Release a version 1.0 of your project: - -```bash -npm run docusaurus docs:version 1.0 -``` - -The `docs` folder is copied into `versioned_docs/version-1.0` and `versions.json` is created. - -Your docs now have 2 versions: - -- `1.0` at `http://localhost:3000/docs/` for the version 1.0 docs -- `current` at `http://localhost:3000/docs/next/` for the **upcoming, unreleased docs** - -## Add a Version Dropdown - -To navigate seamlessly across versions, add a version dropdown. - -Modify the `docusaurus.config.js` file: - -```js title="docusaurus.config.js" -export default { - themeConfig: { - navbar: { - items: [ - // highlight-start - { - type: 'docsVersionDropdown', - }, - // highlight-end - ], - }, - }, -}; -``` - -The docs version dropdown appears in your navbar: - -![Docs Version Dropdown](./img/docsVersionDropdown.png) - -## Update an existing version - -It is possible to edit versioned docs in their respective folder: - -- `versioned_docs/version-1.0/hello.md` updates `http://localhost:3000/docs/hello` -- `docs/hello.md` updates `http://localhost:3000/docs/next/hello` diff --git a/docs/docs/tutorial-extras/translate-your-site.md b/docs/docs/tutorial-extras/translate-your-site.md deleted file mode 100644 index b5a644a..0000000 --- a/docs/docs/tutorial-extras/translate-your-site.md +++ /dev/null @@ -1,88 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Translate your site - -Let's translate `docs/intro.md` to French. - -## Configure i18n - -Modify `docusaurus.config.js` to add support for the `fr` locale: - -```js title="docusaurus.config.js" -export default { - i18n: { - defaultLocale: 'en', - locales: ['en', 'fr'], - }, -}; -``` - -## Translate a doc - -Copy the `docs/intro.md` file to the `i18n/fr` folder: - -```bash -mkdir -p i18n/fr/docusaurus-plugin-content-docs/current/ - -cp docs/intro.md i18n/fr/docusaurus-plugin-content-docs/current/intro.md -``` - -Translate `i18n/fr/docusaurus-plugin-content-docs/current/intro.md` in French. - -## Start your localized site - -Start your site on the French locale: - -```bash -npm run start -- --locale fr -``` - -Your localized site is accessible at [http://localhost:3000/fr/](http://localhost:3000/fr/) and the `Getting Started` page is translated. - -:::caution - -In development, you can only use one locale at a time. - -::: - -## Add a Locale Dropdown - -To navigate seamlessly across languages, add a locale dropdown. - -Modify the `docusaurus.config.js` file: - -```js title="docusaurus.config.js" -export default { - themeConfig: { - navbar: { - items: [ - // highlight-start - { - type: 'localeDropdown', - }, - // highlight-end - ], - }, - }, -}; -``` - -The locale dropdown now appears in your navbar: - -![Locale Dropdown](./img/localeDropdown.png) - -## Build your localized site - -Build your site for a specific locale: - -```bash -npm run build -- --locale fr -``` - -Or build your site to include all the locales at once: - -```bash -npm run build -``` diff --git a/docs/docusaurus.config.ts b/docs/docusaurus.config.ts index c7734c4..4d9bb81 100644 --- a/docs/docusaurus.config.ts +++ b/docs/docusaurus.config.ts @@ -6,7 +6,7 @@ import type * as Preset from "@docusaurus/preset-classic"; const config: Config = { title: "Pulse Editor Documentation", - tagline: "AI-powered editor for developers nad creators on any platform", + tagline: "A modular, cross-platform, AI-powered creative platform built to adapt to your ideas.", favicon: "img/favicon.ico", // Set the production url of your site here @@ -40,8 +40,7 @@ const config: Config = { sidebarPath: "./sidebars.ts", // Please change this to your repo. // Remove this to remove the "edit this page" links. - editUrl: - "https://github.com/ClayPulse/pulse-editor/tree/main/docs/", + editUrl: "https://github.com/ClayPulse/pulse-editor/tree/main/docs/", }, blog: { showReadingTime: true, @@ -51,8 +50,7 @@ const config: Config = { }, // Please change this to your repo. // Remove this to remove the "edit this page" links. - editUrl: - "https://github.com/ClayPulse/pulse-editor/tree/main/docs/", + editUrl: "https://github.com/ClayPulse/pulse-editor/tree/main/docs/", // Useful options to enforce blogging best practices onInlineTags: "warn", onInlineAuthors: "warn", @@ -76,12 +74,27 @@ const config: Config = { }, items: [ { - type: "docSidebar", - sidebarId: "tutorialSidebar", + to: "/docs/guide", + sidebarId: "guideSidebar", position: "left", - label: "Tutorial", + label: "Guide", }, { to: "/blog", label: "Blog", position: "left" }, + { + to: "/docs/api-reference", + sidebarId: "apiRefSidebar", + label: "API Reference", + position: "left", + }, + { + type: "docsVersionDropdown", + position: "right", + versions: { + current: { + label: "Latest", + }, + }, + }, { href: "https://github.com/ClayPulse/pulse-editor", label: "GitHub", @@ -93,11 +106,19 @@ const config: Config = { style: "dark", links: [ { - title: "Docs", + title: "Section", items: [ { - label: "Tutorial", - to: "/docs/intro", + label: "Guide", + to: "/docs/guide", + }, + { + label: "Blog", + to: "/blog", + }, + { + label: "API Reference", + to: "/docs/api-reference", }, ], }, @@ -106,25 +127,29 @@ const config: Config = { items: [ { label: "Discord", - href: "https://discord.gg/DjssdjEq", + href: "https://discord.com/invite/s6J54HFxQp", + }, + { + label: "GitHub", + href: "https://github.com/ClayPulse/pulse-editor", }, ], }, { - title: "More", + title: "Website", items: [ { - label: "Blog", - to: "/blog", + label: "Pulse Editor", + href: "https://pulse-editor.com", }, { - label: "GitHub", - href: "https://github.com/ClayPulse/pulse-editor", + label: "Marketplace", + href: "https://pulse-editor.com/marketplace", }, ], }, ], - copyright: `Copyright © ${new Date().getFullYear()} ClayPulse. Built with Docusaurus.`, + copyright: `ClayPulse AI © ${new Date().getFullYear()}`, }, prism: { theme: prismThemes.github, diff --git a/docs/sidebars.ts b/docs/sidebars.ts index 2897139..487b035 100644 --- a/docs/sidebars.ts +++ b/docs/sidebars.ts @@ -1,4 +1,4 @@ -import type {SidebarsConfig} from '@docusaurus/plugin-content-docs'; +import type { SidebarsConfig } from "@docusaurus/plugin-content-docs"; // This runs in Node.js - Don't use client-side code here (browser APIs, JSX...) @@ -14,7 +14,8 @@ import type {SidebarsConfig} from '@docusaurus/plugin-content-docs'; */ const sidebars: SidebarsConfig = { // By default, Docusaurus generates a sidebar from the docs folder structure - tutorialSidebar: [{type: 'autogenerated', dirName: '.'}], + guideSidebar: [{ type: "autogenerated", dirName: "guide" }], + apiRefSidebar: [{ type: "autogenerated", dirName: "api-reference" }], // But you can create a sidebar manually /* diff --git a/docs/src/components/HomepageFeatures/index.tsx b/docs/src/components/HomepageFeatures/index.tsx deleted file mode 100644 index c2551fb..0000000 --- a/docs/src/components/HomepageFeatures/index.tsx +++ /dev/null @@ -1,71 +0,0 @@ -import type {ReactNode} from 'react'; -import clsx from 'clsx'; -import Heading from '@theme/Heading'; -import styles from './styles.module.css'; - -type FeatureItem = { - title: string; - Svg: React.ComponentType>; - description: ReactNode; -}; - -const FeatureList: FeatureItem[] = [ - { - title: 'Easy to Use', - Svg: require('@site/static/img/undraw_docusaurus_mountain.svg').default, - description: ( - <> - Docusaurus was designed from the ground up to be easily installed and - used to get your website up and running quickly. - - ), - }, - { - title: 'Focus on What Matters', - Svg: require('@site/static/img/undraw_docusaurus_tree.svg').default, - description: ( - <> - Docusaurus lets you focus on your docs, and we'll do the chores. Go - ahead and move your docs into the docs directory. - - ), - }, - { - title: 'Powered by React', - Svg: require('@site/static/img/undraw_docusaurus_react.svg').default, - description: ( - <> - Extend or customize your website layout by reusing React. Docusaurus can - be extended while reusing the same header and footer. - - ), - }, -]; - -function Feature({title, Svg, description}: FeatureItem) { - return ( -
-
- -
-
- {title} -

{description}

-
-
- ); -} - -export default function HomepageFeatures(): ReactNode { - return ( -
-
-
- {FeatureList.map((props, idx) => ( - - ))} -
-
-
- ); -} diff --git a/docs/src/components/HomepageFeatures/styles.module.css b/docs/src/components/HomepageFeatures/styles.module.css deleted file mode 100644 index b248eb2..0000000 --- a/docs/src/components/HomepageFeatures/styles.module.css +++ /dev/null @@ -1,11 +0,0 @@ -.features { - display: flex; - align-items: center; - padding: 2rem 0; - width: 100%; -} - -.featureSvg { - height: 200px; - width: 200px; -} diff --git a/docs/src/css/custom.css b/docs/src/css/custom.css index 2bc6a4c..22a00ba 100644 --- a/docs/src/css/custom.css +++ b/docs/src/css/custom.css @@ -6,25 +6,56 @@ /* You can override the default Infima variables here. */ :root { - --ifm-color-primary: #2e8555; - --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%; + --ifm-color-primary: #754100; + --ifm-color-primary-dark: #693a00; + --ifm-color-primary-darker: #633700; + --ifm-color-primary-darkest: #522d00; + --ifm-color-primary-light: #814700; + --ifm-color-primary-lighter: #874b00; + --ifm-color-primary-lightest: #985400; + --ifm-background-color: #fff8eb; --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: #25c2a0; - --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; +[data-theme="dark"] { + --ifm-color-primary: #fadda0; + --ifm-color-primary-dark: #f8cf79; + --ifm-color-primary-darker: #f7c866; + --ifm-color-primary-darkest: #f4b32b; + --ifm-color-primary-light: #fcebc7; + --ifm-color-primary-lighter: #fdf2da; + --ifm-color-primary-lightest: #ffffff; + --ifm-background-color: #191919; --docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.3); } + +.homepageWrapper { + height: 100%; + width: 100%; + min-height: 480px; +} + +.quickLinks { + display: flex; + flex-direction: row; + gap: 1rem; + justify-content: center; +} + +/* Change to smaller font when screen is less than 480 wide */ +@media screen and (max-width: 540px) { + .hero__title { + font-size: 34px; + } + .hero__subtitle { + font-size: 22px; + } + + .quickLinks { + display: flex; + flex-direction: column; + gap: 1rem; + justify-content: center; + } +} diff --git a/docs/src/pages/index.module.css b/docs/src/pages/index.module.css index 9f71a5d..fe81545 100644 --- a/docs/src/pages/index.module.css +++ b/docs/src/pages/index.module.css @@ -12,7 +12,10 @@ @media screen and (max-width: 996px) { .heroBanner { - padding: 2rem; + padding-top: 2rem; + padding-bottom: 2rem; + padding-left: 0; + padding-right: 0; } } diff --git a/docs/src/pages/index.tsx b/docs/src/pages/index.tsx index 2e006d1..6c2ab53 100644 --- a/docs/src/pages/index.tsx +++ b/docs/src/pages/index.tsx @@ -1,28 +1,45 @@ -import type {ReactNode} from 'react'; -import clsx from 'clsx'; -import Link from '@docusaurus/Link'; -import useDocusaurusContext from '@docusaurus/useDocusaurusContext'; -import Layout from '@theme/Layout'; -import HomepageFeatures from '@site/src/components/HomepageFeatures'; -import Heading from '@theme/Heading'; +import type { ReactNode } from "react"; +import clsx from "clsx"; +import Link from "@docusaurus/Link"; +import useDocusaurusContext from "@docusaurus/useDocusaurusContext"; +import Layout from "@theme/Layout"; +import Heading from "@theme/Heading"; -import styles from './index.module.css'; +import styles from "./index.module.css"; function HomepageHeader() { - const {siteConfig} = useDocusaurusContext(); + const { siteConfig } = useDocusaurusContext(); return ( -
+
{siteConfig.title}

{siteConfig.tagline}

-
- - Docusaurus Tutorial - 5min ⏱️ - + +
+
+ + Pulse Editor Guide + +
+
+ + API Reference + +
@@ -30,15 +47,33 @@ function HomepageHeader() { } export default function Home(): ReactNode { - const {siteConfig} = useDocusaurusContext(); return ( - - -
- -
- +
+ +
+ +
+ +
); } diff --git a/docs/src/pages/markdown-page.md b/docs/src/pages/markdown-page.md deleted file mode 100644 index 9756c5b..0000000 --- a/docs/src/pages/markdown-page.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -title: Markdown page example ---- - -# Markdown page example - -You don't need React to write simple standalone pages. diff --git a/mobile/README.md b/mobile/README.md deleted file mode 100644 index c4e503f..0000000 --- a/mobile/README.md +++ /dev/null @@ -1,42 +0,0 @@ -# Mobile User Guide -### Installation - -An Android APK is available in our GitHub release page. - -(Currently we only support Android, although it is technically possible to have an iOS build — check out our developer guide on GitHub for building iOS client) - -You must then configure settings in the app. Specifically, to use Voice Chat, you need to have all STT, LLM, TTS configured; to only use Agentic Chat Terminal or Code Completion, you need to configure LLM. - -| Modality | Supported Provider | -| --- | --- | -| STT | OpenAI | -| LLM | OpenAI | -| TTS | OpenAI, ElevenLabs | - -(For TTS, you need to enter a voice name or voice ID which you can find from your provider. e.g. “alloy” for OpenAI TTS1, “Maltida” for ElevenLabs.) - -### Open File - -Click the menu at top-left corner, then click either “new file” to get an empty file or “open file” to select one from your file system. - -### Voice Chat - -(Make sure you have configured all STT, LLM, TTS providers and API keys) - -Click the microphone icon in the bottom toolbar, and grant permission if prompted. Then start chatting using voice. Any code changes will be made in the code view once the request completes. - -### Drawing Gesture - -Click the pen icon in the bottom toolbar, and start drawing using your finger. If you wish to restart, simply toggle off and on the pen tool again. - -### Agentic Chat Terminal - -(Make sure you have configured LLM provider and API key) - -Click the “Open Chat View” icon in the bottom toolbar. Then select your desire agent, or define your own by clicking the plus icon. Next, start chatting by typing in text in the input box. - -### Code Completion - -(Make sure you have configured LLM provider and API key) - -Type anything in an open file, then a suggestion would become available in grey text. Swipe right to accept changes, or keep typing to refresh new suggest. \ No newline at end of file