Merge pull request #46 from ClayPulse/add-docs

Remove docusaurus template and add partial docs

Author: Shellishack

.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

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.
 
-
-
 <p align="center">
   <img alt="Pulse Editor" src="shared-assets/icons/pulse_logo.svg"/>
 </p>
@@ -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)
+
 </div>
 
 # Table of Contents
+
 <span style="font-size: 16px;">
 
 - [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
 </span>
 
 # 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 [email protected] 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)

desktop/README.md

@@ -0,0 +1,6 @@
+---
+sidebar_position: 1
+---
+
+# Introduction
+This is 

docs/docs/api-reference/index.md

@@ -0,0 +1,4 @@
+{
+  "label": "Development Guide",
+  "position": 6
+}

docs/docs/guide/develop-extensions/_category_.json

@@ -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
+```

docs/docs/guide/develop-extensions/cli.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';
+
+<DocCardList />

docs/docs/guide/develop-extensions/index.md

@@ -0,0 +1,4 @@
+{
+  "label": "Develop Extensions with React",
+  "position": 2
+}

docs/docs/guide/develop-extensions/react/_category_.json

@@ -0,0 +1 @@
+# React

docs/docs/guide/develop-extensions/react/index.md

@@ -0,0 +1 @@
+# React Starter Template