diff --git a/README.md b/README.md deleted file mode 100644 index 0bafe66..0000000 --- a/README.md +++ /dev/null @@ -1,244 +0,0 @@ -

-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 -

- -
- -[![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) -- [Introduction](#introduction) -- [Beta Release Roadmap](#beta-release-roadmap) - - [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 and Guide](#documentation-and-guide) -- [Getting Started -- User Guide](#getting-started----user-guide) - - [Web Client](#web-client) - - [Mobile Client](#mobile-client) - - [Desktop Client](#desktop-client) - - [VSCode Extension](#vscode-extension) -- [Getting Started -- Development Guide](#getting-started----development-guide) - - [Recommended Nodejs version](#recommended-nodejs-version) - - [Install dependencies](#install-dependencies) - - [Install dependencies (desktop native modules)](#install-dependencies-desktop-native-modules) - - [For Windows](#for-windows) - - [For Linux](#for-linux) - - [Web Development](#web-development) - - [Mobile Development](#mobile-development) - - [Desktop Development](#desktop-development) - - [VSCode Extension Development](#vscode-extension-development) - - [Pulse Editor Extension Development](#pulse-editor-extension-development) - - - -# 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. - -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) -- (Official) [Pulse Editor Video Editor (MIT)](https://github.com/Shellishack/pulse-editor-video-editor) - -Pulse Editor Marketplace Developer Access is now open for application. If you'd like to develop and publish your own extensions to Pulse Editor Marketplace, submit a form here [Developer Beta Access](https://pulse-editor.com/beta). - -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 -- Extension app AI builder -- ... (WIP) - -~~Coming Soon: [Making 100 Extension Apps Challenge](https://github.com/shellishack)~~ - -### Major Beta Release 3 (planned for 2025 Q4) - -... (WIP) - -# 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://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). - -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: - -```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 -# Production -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. - -Pulse Editor uses VSCode Webview API to create a VSCode Extension. To develop VScode Extension locally, open the `vscode-extension` in a separate VSCode window. Then press F5 to launch debug task. - -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/docs/blog/2019-05-28-first-blog-post.md b/docs/blog/2019-05-28-first-blog-post.md deleted file mode 100644 index d3032ef..0000000 --- a/docs/blog/2019-05-28-first-blog-post.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -slug: first-blog-post -title: First Blog Post -authors: [slorber, yangshun] -tags: [hola, docusaurus] ---- - -Lorem ipsum dolor sit amet... - - - -...consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet diff --git a/docs/blog/2019-05-29-long-blog-post.md b/docs/blog/2019-05-29-long-blog-post.md deleted file mode 100644 index eb4435d..0000000 --- a/docs/blog/2019-05-29-long-blog-post.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -slug: long-blog-post -title: Long Blog Post -authors: yangshun -tags: [hello, docusaurus] ---- - -This is the summary of a very long blog post, - -Use a `` comment to limit blog post size in the list view. - - - -Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet - -Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet - -Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet - -Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet - -Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet - -Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet - -Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet - -Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet - -Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet - -Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet - -Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet - -Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet - -Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet - -Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet - -Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet - -Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet diff --git a/docs/blog/2021-08-01-mdx-blog-post.mdx b/docs/blog/2021-08-01-mdx-blog-post.mdx deleted file mode 100644 index 0c4b4a4..0000000 --- a/docs/blog/2021-08-01-mdx-blog-post.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -slug: mdx-blog-post -title: MDX Blog Post -authors: [slorber] -tags: [docusaurus] ---- - -Blog posts support [Docusaurus Markdown features](https://docusaurus.io/docs/markdown-features), such as [MDX](https://mdxjs.com/). - -:::tip - -Use the power of React to create interactive blog posts. - -::: - -{/* truncate */} - -For example, use JSX to create an interactive button: - -```js - -``` - - diff --git a/docs/blog/2021-08-26-welcome/docusaurus-plushie-banner.jpeg b/docs/blog/2021-08-26-welcome/docusaurus-plushie-banner.jpeg deleted file mode 100644 index 11bda09..0000000 Binary files a/docs/blog/2021-08-26-welcome/docusaurus-plushie-banner.jpeg and /dev/null differ diff --git a/docs/blog/2021-08-26-welcome/index.md b/docs/blog/2021-08-26-welcome/index.md deleted file mode 100644 index 349ea07..0000000 --- a/docs/blog/2021-08-26-welcome/index.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -slug: welcome -title: Welcome -authors: [slorber, yangshun] -tags: [facebook, hello, docusaurus] ---- - -[Docusaurus blogging features](https://docusaurus.io/docs/blog) are powered by the [blog plugin](https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-content-blog). - -Here are a few tips you might find useful. - - - -Simply add Markdown files (or folders) to the `blog` directory. - -Regular blog authors can be added to `authors.yml`. - -The blog post date can be extracted from filenames, such as: - -- `2019-05-30-welcome.md` -- `2019-05-30-welcome/index.md` - -A blog post folder can be convenient to co-locate blog post images: - -![Docusaurus Plushie](./docusaurus-plushie-banner.jpeg) - -The blog supports tags as well! - -**And if you don't want a blog**: just delete this directory, and use `blog: false` in your Docusaurus config. diff --git a/docs/blog/2025-06-01-pulse-editor-beta-launch-agentx-submission.md b/docs/blog/2025-06-01-pulse-editor-beta-launch-agentx-submission.md new file mode 100644 index 0000000..dcd6349 --- /dev/null +++ b/docs/blog/2025-06-01-pulse-editor-beta-launch-agentx-submission.md @@ -0,0 +1,77 @@ +--- +slug: early-beta-launch-agentx-submission +title: 🎉 Pulse Editor Beta Launch + AgentX Competition Submission! +authors: [shellishack] +tags: [Announcement, Beta, AgentX, AI, Creativity, Extensions] +date: 2025-06-02 +--- + +🚀 **Big News — Pulse Editor Early Beta Is Here!** + +We're thrilled to announce the **Early Beta Release 1 of Pulse Editor** and our **official submission to the AgentX Competition**! It’s a huge milestone for us, and we’re beyond excited to share what we’ve been working on. + +🎥 **Watch the Early Beta Demo Video** +Check out the first look at Pulse Editor in action: +👉 [YouTube Demo – Pulse Editor Early Beta](https://www.youtube.com/watch?v=GqNOtgfFrWI) + +--- + +## 💡 What is Pulse Editor? + +> _"What if one tool could bring every creative idea to life?"_ + +Pulse Editor is your **AI-powered, modular, and cross-platform creative workspace**—built to adapt to how you work and think, whether you're coding, designing, writing, or building entirely new tools. + +### 🌟 Key Features: +- **Creative AI Assistants** to help you brainstorm, code, and automate +- **Voice interaction** with your editor or terminal +- **Real-time AI suggestions** and previews, even on mobile +- **AI-assisted image and video editing** +- **Extensible architecture** via Pulse Editor Marketplace for workflows, tools, and automations + +--- + +## 🧪 Try the Beta Now + +You can now download **Early Beta builds** for **Windows** and **Android**: +👉 [Download v0.1.0-beta.0 on GitHub](https://github.com/ClayPulse/pulse-editor/releases/tag/v0.1.0-beta.0) + +> _Note: Mac and web builds are coming soon!_ + +--- + +## 🛠️ Developers — Apply for Limited Extension Access + +We’re opening up early access for developers to build and publish extensions for the Pulse Editor Marketplace. Interested? + +👉 [Apply for Limited Developer Access](https://pulse-editor.com/beta) + +--- + +## 🐛 Bugs? Ideas? Talk to Us! + +- 🧵 Questions or casual chat? Drop into `#general` on our [Discord](https://discord.com/invite/s6J54HFxQp) +- 🐞 Found a bug or have a feature request? [Open an issue on GitHub](https://github.com/ClayPulse/pulse-editor/issues) + +Documentation is still a work in progress, but updates are coming soon at: +- [GitHub Wiki / Docs](https://github.com/ClayPulse/pulse-editor) +- [Official Docs Site](https://docs.pulse-editor.com) + +--- + +## 🔮 What’s Next? + +We’re moving fast — and July will bring: +- More AI features into the beta build +- Updated documentation and user guides +- Improved mobile + web UX +- Our **“100 Extension Apps” Challenge** 👀 + +--- + +Thank you so much to our early community for your incredible support. This is just the beginning—and we can’t wait to shape the future of creative AI with you. + +✨ _Start building, exploring, and creating with Pulse Editor today._ +💬 _Join the journey. Let’s create the future—together._ + +— The ClayPulse Team diff --git a/docs/blog/authors.yml b/docs/blog/authors.yml index 8bfa5c7..6d01442 100644 --- a/docs/blog/authors.yml +++ b/docs/blog/authors.yml @@ -1,23 +1,9 @@ -yangshun: - name: Yangshun Tay - title: Front End Engineer @ Facebook - url: https://github.com/yangshun - image_url: https://github.com/yangshun.png - page: true - socials: - x: yangshunz - github: yangshun - -slorber: - name: Sébastien Lorber - title: Docusaurus maintainer - url: https://sebastienlorber.com - image_url: https://github.com/slorber.png - page: - # customize the url of the author page at /blog/authors/ - permalink: '/all-sebastien-lorber-articles' +shellishack: + name: Ellis Shang + title: Founder of ClayPulse AI + image_url: https://github.com/shellishack.png socials: - x: sebastienlorber - linkedin: sebastienlorber - github: slorber - newsletter: https://thisweekinreact.com + github: shellishack + linkedin: ellisshang + page: true + diff --git a/docs/blog/tags.yml b/docs/blog/tags.yml deleted file mode 100644 index bfaa778..0000000 --- a/docs/blog/tags.yml +++ /dev/null @@ -1,19 +0,0 @@ -facebook: - label: Facebook - permalink: /facebook - description: Facebook tag description - -hello: - label: Hello - permalink: /hello - description: Hello tag description - -docusaurus: - label: Docusaurus - permalink: /docusaurus - description: Docusaurus tag description - -hola: - label: Hola - permalink: /hola - description: Hola tag description diff --git a/docs/docs/guide/quick-start/configure-ai-agents.md b/docs/docs/guide/quick-start/configure-ai-agents.md deleted file mode 100644 index 5e1f31d..0000000 --- a/docs/docs/guide/quick-start/configure-ai-agents.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Configure AI Agents diff --git a/docs/docs/guide/quick-start/example-use-cases/coding.md b/docs/docs/guide/quick-start/example-use-cases/coding.md new file mode 100644 index 0000000..d570033 --- /dev/null +++ b/docs/docs/guide/quick-start/example-use-cases/coding.md @@ -0,0 +1,61 @@ +# Coding + +Pulse Editor Code View is an AI-powered code editor based on CodeMirror 6. Install Pulse Editor Code View from marketplace and get started coding using Pulse Editor today. + +:::info **Your Contribution Is Needed!** +Pulse Editor Code is at its early stages — and you can help shape its future. + +We're building early extensions and tools to make Pulse Editor more powerful and accessible for everyone. Whether you're passionate about open source, UI/UX, or developer tools, there's a place for you in our community. + +👉 Join us, share your ideas, and help make Pulse Editor available to more people around the world. + +- [Contribute to Pulse Editor on GitHub](https://github.com/ClayPulse/pulse-editor) +- [Contribute to Pulse Editor Code on GitHub](https://github.com/ClayPulse/pulse-editor-code-view) +- [Join the Community Chat](https://discord.com/invite/s6J54HFxQp) + ::: + +## Install Pulse Editor Code View + +Click icon in the toolbar at bottom of screen to browse available extension apps. Search for `Pulse Editor Code View`, then install. + +## Create a new source file + +:::info +Make sure you have opened a project. To open a project, you can click in top navigation bar to open project explorer. Then click on the project that you want to open, or create a new project. See [Manage Projects](http://localhost:3000/docs/guide/quick-start/manage-projects) for more details. +::: + +Open the project explorer by clicking in top navigation. Now click the icon to create a new file, then enter file name to create the file. + +Once the file is created, you can click it to open. If you want to change its name or delete it, you can right-click or hold (mobile) to open a context menu where you can find these options. + +## Open a source file + +If your filename's suffixes are registered by the Code View extension, Pulse Editor Code View should load upon opening the file. + +You can find a list of [supported file suffixes](https://github.com/ClayPulse/pulse-editor-code-view/blob/main/pulse.config.ts#L21) and [supported programming languages](https://github.com/ClayPulse/pulse-editor-code-view/blob/main/src/lib/codemirror-extensions/get-language-extension.ts) in our [Pulse Editor Code View repository](https://github.com/ClayPulse/pulse-editor-code-view). + +## Start coding + +Now you can enjoy coding with Pulse Editor Code View. Pulse Editor Code View comes with the following AI features: + +### Using code completion + +You can use code completion just similar to code copilot from VSCode by entering some preceding text, then Code View will call a code agent to autocomplete the following line(s) for you. When you see grayed out text prediction, simply press `tab` to accept on desktop, or `swipe right` to accept on mobile. + +### Using code agent command + +The Code View extensions exposes a command that calls code agents to modify code file. This means you can call this command via typing it out (WIP), or Pulse Editor Creative Assistant can call this command on your behalf. + +- To run this command yourself (WIP) + (WIP) +- To let Pulse Editor Creative Assistant to call it on your behalf + - Via voice chat: You can click to chat with Creative Assistant using voice + - Via chatbot interface (WIP): + +## Run program in terminal + +Pulse Editor Terminal is a separate extension that you can install from the marketplace. This enables you to run terminal on desktop or mobile (Android only). The desktop terminal should open automatically once the extension is installed and terminal console is opened. For mobile, see [Pulse Editor Terminal guide](https://github.com/ClayPulse/pulse-editor-terminal). + +:::info +We are working hard to support web development environment. Stay tuned! +::: diff --git a/docs/docs/guide/quick-start/example-use-cases/image.md b/docs/docs/guide/quick-start/example-use-cases/image.md new file mode 100644 index 0000000..a9f51b2 --- /dev/null +++ b/docs/docs/guide/quick-start/example-use-cases/image.md @@ -0,0 +1,5 @@ +# Generating and Editing Images + +Pulse Editor Image View is an image editor (WIP), augmented with generative AI to assist the creative process. + +WIP \ No newline at end of file diff --git a/docs/docs/guide/quick-start/example-use-cases/index.md b/docs/docs/guide/quick-start/example-use-cases/index.md new file mode 100644 index 0000000..037d659 --- /dev/null +++ b/docs/docs/guide/quick-start/example-use-cases/index.md @@ -0,0 +1,6 @@ +# Example Use Cases + + +import DocCardList from '@theme/DocCardList'; + + \ No newline at end of file diff --git a/docs/docs/guide/quick-start/example-use-cases/video.md b/docs/docs/guide/quick-start/example-use-cases/video.md new file mode 100644 index 0000000..f4c1e50 --- /dev/null +++ b/docs/docs/guide/quick-start/example-use-cases/video.md @@ -0,0 +1,5 @@ +# Generating and Editing Videos + +Pulse Editor Image View is a video editor (WIP), augmented with generative AI to assist the creative process. + +WIP \ No newline at end of file diff --git a/docs/docs/guide/quick-start/how-to-use-extensions.md b/docs/docs/guide/quick-start/how-to-use-extensions.md index 82c71cd..b0d7010 100644 --- a/docs/docs/guide/quick-start/how-to-use-extensions.md +++ b/docs/docs/guide/quick-start/how-to-use-extensions.md @@ -1,13 +1,35 @@ --- -sidebar_position: 2 +sidebar_position: 3 --- # 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. +There are two types of extensions: + +- **File View Extension** + File View Extension is opened when a file is opened in view. Pulse Editor determines which extension to load based on a file's type/suffix/extension. e.g. **.txt**, **.png**, **.py** +- **Console View Extension** + Console View Extension is opened without a file view object. Often it does not need to interact with a file (reading/writing). You can open the console panel by clicking in the toolbar, then you can find all installed Console View Extensions. + :::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). ::: + +## Browse extension marketplace + +Once you have installed Pulse Editor on your preferred device, you can click icon in the toolbar at bottom of screen to browse available extension apps. +Click on the extension card to view details about its features, authors, and usage plans. + +## Install extensions from marketplace + +Click icon in the toolbar at bottom of screen to browse available extension apps. You can install extension apps by clicking on any extension card, then clicking the "install" button. + +## Configure extension settings + +You can configure extension settings by following these steps: + +1. Click in the toolbar at bottom of screen. +2. Go to extension settings section, find the extension that you'd like to configure. +3. Configure extension specific settings. diff --git a/docs/docs/guide/quick-start/manage-projects.md b/docs/docs/guide/quick-start/manage-projects.md new file mode 100644 index 0000000..0efd310 --- /dev/null +++ b/docs/docs/guide/quick-start/manage-projects.md @@ -0,0 +1,32 @@ +--- +sidebar_position: 2 +--- + +# Manage Projects + +Manage your projects with Pulse Editor on every device, and optionally on the cloud (WIP). + +## Create a project + +You can create a projects by these steps: + +1. Click in top navigation bar to open project explorer. Here you can view your existing projects. +2. Click `create new project` button to make a new project. +3. Enter project information. + +## Open a project + +To open a project, click in top navigation bar to open project explorer. Then click on the project that you want to open. + +## Close a project + +At top-center of Pulse Editor, you can find a `project indicator` showing your project's name. Click the chevron icon to view project menu, and choose `close project` to close the current project. + +## Edit project settings + +There are two ways to edit your project's settings: + +- **When the project is open** + At top-center of Pulse Editor, you can find a `project indicator` showing your project's name. Click the chevron icon to view project menu, and choose `project settings` to configure your project. +- **When the project is not open** + Click in top navigation bar to open project explorer. Then right-click or hold (mobile) on a project that you want to modify, choose `project settings` to configure your project. diff --git a/docs/docs/guide/quick-start/set-up-pulse-editor.md b/docs/docs/guide/quick-start/set-up-pulse-editor.md index b6463bd..8b916a4 100644 --- a/docs/docs/guide/quick-start/set-up-pulse-editor.md +++ b/docs/docs/guide/quick-start/set-up-pulse-editor.md @@ -2,7 +2,7 @@ sidebar_position: 1 --- -# Set up Pulse Editor +# Set Up Pulse Editor ## Configuring AI models in Pulse Editor diff --git a/docs/docusaurus.config.ts b/docs/docusaurus.config.ts index 4d9bb81..bde42fe 100644 --- a/docs/docusaurus.config.ts +++ b/docs/docusaurus.config.ts @@ -6,7 +6,8 @@ import type * as Preset from "@docusaurus/preset-classic"; const config: Config = { title: "Pulse Editor Documentation", - tagline: "A modular, cross-platform, AI-powered creative platform built to adapt to your ideas.", + 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 @@ -95,6 +96,16 @@ const config: Config = { }, }, }, + { + href: "https://pulse-editor.com", + label: "Website", + position: "right", + }, + { + href: "https://discord.com/invite/s6J54HFxQp", + label: "Discord", + position: "right", + }, { href: "https://github.com/ClayPulse/pulse-editor", label: "GitHub", diff --git a/docs/package-lock.json b/docs/package-lock.json index d7d79ea..315b8b9 100644 --- a/docs/package-lock.json +++ b/docs/package-lock.json @@ -12,6 +12,7 @@ "@docusaurus/preset-classic": "3.8.0", "@mdx-js/react": "^3.1.0", "clsx": "^2.1.1", + "material-icons": "^1.13.14", "prism-react-renderer": "^2.4.1", "react": "^19.1.0", "react-dom": "^19.1.0" @@ -5505,9 +5506,9 @@ } }, "node_modules/brace-expansion": { - "version": "1.1.11", - "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.11.tgz", - "integrity": "sha512-iCuPHDFgrHX7H2vEI/5xpz07zSHB00TpugqhmYtVmMO6518mCuRMoOYFldEBl0g187ufozdaHgWKcYFb61qGiA==", + "version": "1.1.12", + "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.12.tgz", + "integrity": "sha512-9T9UjW3r0UW5c1Q7GTwllptXwhvYmEzFhzMfZ9H7FQWt+uZePjZPjBP/W1ZEyZ1twGWom5/56TF4lPcqjnDHcg==", "license": "MIT", "dependencies": { "balanced-match": "^1.0.0", @@ -9722,6 +9723,12 @@ "url": "https://github.com/sponsors/wooorm" } }, + "node_modules/material-icons": { + "version": "1.13.14", + "resolved": "https://registry.npmjs.org/material-icons/-/material-icons-1.13.14.tgz", + "integrity": "sha512-kZOfc7xCC0rAT8Q3DQixYAeT+tBqZnxkseQtp2bxBxz7q5pMAC+wmit7vJn1g/l7wRU+HEPq23gER4iPjGs5Cg==", + "license": "Apache-2.0" + }, "node_modules/math-intrinsics": { "version": "1.1.0", "resolved": "https://registry.npmjs.org/math-intrinsics/-/math-intrinsics-1.1.0.tgz", diff --git a/docs/package.json b/docs/package.json index 968f7f1..2248469 100644 --- a/docs/package.json +++ b/docs/package.json @@ -19,6 +19,7 @@ "@docusaurus/preset-classic": "3.8.0", "@mdx-js/react": "^3.1.0", "clsx": "^2.1.1", + "material-icons": "^1.13.14", "prism-react-renderer": "^2.4.1", "react": "^19.1.0", "react-dom": "^19.1.0" diff --git a/docs/src/components/icon.tsx b/docs/src/components/icon.tsx new file mode 100644 index 0000000..1a1b4b8 --- /dev/null +++ b/docs/src/components/icon.tsx @@ -0,0 +1,23 @@ +export default function Icon({ + name, + variant, +}: { + name?: string; + variant?: "outlined" | "round" | "sharp" | "two-tone"; +}) { + if (!name) { + throw new Error("Icon component requires a name."); + } + + return ( + + {name} + + ); +} diff --git a/docs/src/pages/index.tsx b/docs/src/pages/index.tsx index 6c2ab53..f8c70f9 100644 --- a/docs/src/pages/index.tsx +++ b/docs/src/pages/index.tsx @@ -6,6 +6,7 @@ import Layout from "@theme/Layout"; import Heading from "@theme/Heading"; import styles from "./index.module.css"; +import "material-icons/iconfont/material-icons.css"; function HomepageHeader() { const { siteConfig } = useDocusaurusContext(); diff --git a/docs/src/theme/MDXComponents.js b/docs/src/theme/MDXComponents.js new file mode 100644 index 0000000..e80faa0 --- /dev/null +++ b/docs/src/theme/MDXComponents.js @@ -0,0 +1,10 @@ +import React from "react"; +// Import the original mapper +import MDXComponents from "@theme-original/MDXComponents"; +import Icon from "../components/icon"; + +export default { + // Re-use the default mapping + ...MDXComponents, + Icon, +};