diff --git a/docs.json b/docs.json index f6930ba..f062a84 100644 --- a/docs.json +++ b/docs.json @@ -11,28 +11,16 @@ "path": "/docs/01-overview/01-about-chai-builder.md" }, { - "id": "01-overview/02-open-source-website-builder.md", - "title": "Open Source Website Builder", - "slug": "/docs/overview/open-source-website-builder", - "path": "/docs/01-overview/02-open-source-website-builder.md" - }, - { - "id": "01-overview/03-chaibuilder-sdk-vs-pages.md", - "title": "Chaibuilder Sdk Vs Pages", - "slug": "/docs/overview/chaibuilder-sdk-vs-pages", - "path": "/docs/01-overview/03-chaibuilder-sdk-vs-pages.md" - }, - { - "id": "01-overview/04-changelog.md", + "id": "01-overview/02-changelog.md", "title": "Changelog", "slug": "/docs/overview/changelog", - "path": "/docs/01-overview/04-changelog.md" + "path": "/docs/01-overview/02-changelog.md" }, { - "id": "01-overview/05-roadmap.md", + "id": "01-overview/03-roadmap.md", "title": "Roadmap", "slug": "/docs/overview/roadmap", - "path": "/docs/01-overview/05-roadmap.md" + "path": "/docs/01-overview/03-roadmap.md" } ] }, @@ -117,5 +105,24 @@ "path": "/docs/03-editors/01-creating-new-page.md" } ] + }, + { + "id": "04-open-source", + "title": "Open Source", + "slug": "/docs/open-source", + "children": [ + { + "id": "04-open-source/01-react-sdk.md", + "title": "React Sdk", + "slug": "/docs/open-source/react-sdk", + "path": "/docs/04-open-source/01-react-sdk.md" + }, + { + "id": "04-open-source/02-chai-blocks.md", + "title": "Chai Blocks", + "slug": "/docs/open-source/chai-blocks", + "path": "/docs/04-open-source/02-chai-blocks.md" + } + ] } ] \ No newline at end of file diff --git a/docs/01-overview/04-changelog.md b/docs/01-overview/02-changelog.md similarity index 100% rename from docs/01-overview/04-changelog.md rename to docs/01-overview/02-changelog.md diff --git a/docs/01-overview/03-chaibuilder-sdk-vs-pages.md b/docs/01-overview/03-chaibuilder-sdk-vs-pages.md deleted file mode 100644 index 53b31f5..0000000 --- a/docs/01-overview/03-chaibuilder-sdk-vs-pages.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -title: Chai Builder SDK vs Pages -description: This page explains the difference between @chaiBuilder/sdk and @chaibuilder/pages packages ---- - -ChaiBuilder offers two primary methods for creating and deploying websites: **SDK** and **Pages**. Each provides unique functionalities tailored to different user needs and project complexities. - -## Chai Builder SDK (Software Development Kit) - -The ChaiBuilder SDK is a React library featuring a component that integrates a complete visual website builder directly into your React application. It handles the rendering and editing of website blocks through structured JSON data, which can be saved and fetched by your custom logic. - -### Key Features: - -* **React Integration:** Easily embed a full-featured visual website builder within your existing React applications. -* **JSON Structure:** Simple structure management—enter structured JSON, edit visually, then export updated JSON. -* **RenderChaiBlock Component:** Directly render JSON structures as HTML using the `RenderChaiBlock` component. -* **Extensible API:** Extend builder functionality through the Extensions API, including custom sidebar panels, custom blocks, custom top bars, and more. - -### Best suited for: - -* Developers needing deep integration within custom React applications. -* Projects requiring precise control over data handling, storage, and block rendering. -* Teams wanting to build custom extensions and functionalities. - -### Limitations: - -* Requires manual handling of saving and fetching block data. -* Targeted towards developers familiar with React. - ---- - -## Chai Builder Pages - -ChaiBuilder Pages extends the functionality of the SDK by leveraging its Extensions API to provide a fully integrated and user-friendly website-building solution. Pages adds built-in panels for essential website management tasks such as SEO, publishing, version control, language management, and more. - -### Key Features: - -* **Enhanced Visual Builder:** Pre-configured builder environment optimized for end-users. -* **Built-in Panels:** Integrated SEO management, publishing, restoration of previous versions, and multilingual support. -* **Cloud Service Integration:** Premium service relying on ChaiBuilder cloud infrastructure for data storage and seamless operation. -* **White Label Offering:** Available as a white-label solution for businesses needing branding control and customization. - -### Best suited for: - -* Users seeking an out-of-the-box, comprehensive website builder. -* Teams preferring minimal development effort and rapid deployment. -* Companies requiring a white-label website builder solution. - -### Limitations: - -* Dependent on ChaiBuilder’s cloud service (unless utilizing white-label). -* Premium product offering with associated costs. - ---- - -## Comparative Overview - -| Aspect | SDK | Pages | -| -------------------------- | ------------------------------ | ------------------------------ | -| **Core Functionality** | JSON-based visual builder | Enhanced, integrated builder | -| **Customization Level** | High with Extensions API | Moderate with pre-built panels | -| **Integration Complexity** | Developer-managed integrations | Built-in integrations | -| **Cloud Dependency** | None (optional) | Required (premium offering) | -| **User Experience** | Developer-oriented | End-user friendly | -| **White-label Solution** | Custom-built | Available as turnkey solution | - -### Decision Guide: - -* **Choose SDK** for detailed customization, full control over data and integration, and developer-centric use cases. -* **Choose Pages** for streamlined, ready-to-use, end-user-friendly site-building, supported by ChaiBuilder cloud services, with optional white-label branding. diff --git a/docs/01-overview/05-roadmap.md b/docs/01-overview/03-roadmap.md similarity index 100% rename from docs/01-overview/05-roadmap.md rename to docs/01-overview/03-roadmap.md diff --git a/docs/01-overview/02-open-source-website-builder.md b/docs/04-open-source/01-react-sdk.md similarity index 100% rename from docs/01-overview/02-open-source-website-builder.md rename to docs/04-open-source/01-react-sdk.md diff --git a/docs/04-open-source/02-chai-blocks.md b/docs/04-open-source/02-chai-blocks.md new file mode 100644 index 0000000..4cc71e7 --- /dev/null +++ b/docs/04-open-source/02-chai-blocks.md @@ -0,0 +1,4 @@ +--- +title: Chai Blocks +description : +--- \ No newline at end of file