From b44176661f31bcb3d38c9a0fd332a82ffbc6dfc8 Mon Sep 17 00:00:00 2001 From: SrGooglo Date: Tue, 13 May 2025 12:48:19 +0000 Subject: [PATCH] Move documentations to external folder --- docs/comty-cli/_category_.json | 7 ++ .../comty-js => comty-cli}/getting-started.md | 1 - docs/comty-js/_category_.json | 7 ++ docs/{docs => }/comty-js/authentication.md | 0 .../comty-js/definitions/_category_.json | 0 .../definitions/like-status-object.md | 0 .../comty-js/definitions/post-object.md | 0 .../definitions/save-status-object.md | 0 docs/comty-js/getting-started.md | 37 +++++++ docs/comty-js/installing.md | 103 ++++++++++++++++++ .../comty-js/models/_category_.json | 0 .../comty-js/models/auth/_category_.json | 0 .../comty-js/models/auth/availability.md | 0 .../comty-js/models/auth/change-password.md | 0 docs/{docs => }/comty-js/models/auth/login.md | 0 .../{docs => }/comty-js/models/auth/logout.md | 0 .../comty-js/models/auth/register.md | 0 .../comty-js/models/auth/user-validation.md | 0 docs/{docs => }/comty-js/models/chats.md | 0 docs/{docs => }/comty-js/models/feed.md | 0 .../comty-js/models/follows/_category_.json | 0 .../comty-js/models/follows/im-following.md | 0 docs/{docs => }/comty-js/models/music.md | 0 docs/{docs => }/comty-js/models/nfc.md | 0 .../comty-js/models/post/_category_.json | 0 .../comty-js/models/post/create-post.md | 0 .../comty-js/models/post/delete-post.md | 0 .../models/post/get-my-liked-posts.md | 0 .../comty-js/models/post/get-post-data.md | 0 .../comty-js/models/post/get-post-replies.md | 0 .../comty-js/models/post/get-saved-posts.md | 0 .../comty-js/models/post/get-user-posts.md | 0 .../comty-js/models/post/toggle-like.md | 0 .../comty-js/models/post/toggle-save.md | 0 .../comty-js/models/post/update-post.md | 0 docs/{docs => }/comty-js/models/search.md | 0 docs/{docs => }/comty-js/models/session.md | 0 docs/{docs => }/comty-js/models/user.md | 0 docs/development/_category_.json | 7 ++ docs/development/getting-started.md | 64 +++++++++++ docs/docs/client-sdk/_category_.json | 7 -- docs/docs/client-sdk/getting-started.md | 6 - docs/docs/comty-cli/_category_.json | 7 -- docs/docs/comty-cli/getting-started.md | 6 - docs/docs/comty-js/_category_.json | 7 -- docs/docs/comty-js/installing.md | 5 - docs/docs/spectrum-api/_category_.json | 7 -- docs/docs/spectrum-api/getting-started.md | 6 - docs/legal/tos.md | 1 - {docs => docusaurus}/.gitignore | 0 {docs => docusaurus}/README.md | 0 {docs => docusaurus}/babel.config.js | 0 {docs => docusaurus}/docusaurus.config.js | 18 +-- {docs => docusaurus}/package.json | 0 {docs => docusaurus}/sidebars.js | 7 +- .../src/components/HomepageFeatures/index.js | 0 .../HomepageFeatures/styles.module.css | 0 {docs => docusaurus}/src/css/custom.css | 0 {docs => docusaurus}/src/pages/index.js | 0 .../src/pages/index.module.css | 0 .../src/pages/markdown-page.md | 0 {docs => docusaurus}/static/.nojekyll | 0 .../static/img/docusaurus-social-card.jpg | Bin .../static/img/docusaurus.png | Bin {docs => docusaurus}/static/img/favicon.ico | Bin {docs => docusaurus}/static/img/logo.svg | 0 .../static/img/undraw_docusaurus_mountain.svg | 0 .../static/img/undraw_docusaurus_react.svg | 0 .../static/img/undraw_docusaurus_tree.svg | 0 69 files changed, 239 insertions(+), 64 deletions(-) create mode 100644 docs/comty-cli/_category_.json rename docs/{docs/comty-js => comty-cli}/getting-started.md (71%) create mode 100644 docs/comty-js/_category_.json rename docs/{docs => }/comty-js/authentication.md (100%) rename docs/{docs => }/comty-js/definitions/_category_.json (100%) rename docs/{docs => }/comty-js/definitions/like-status-object.md (100%) rename docs/{docs => }/comty-js/definitions/post-object.md (100%) rename docs/{docs => }/comty-js/definitions/save-status-object.md (100%) create mode 100644 docs/comty-js/getting-started.md create mode 100644 docs/comty-js/installing.md rename docs/{docs => }/comty-js/models/_category_.json (100%) rename docs/{docs => }/comty-js/models/auth/_category_.json (100%) rename docs/{docs => }/comty-js/models/auth/availability.md (100%) rename docs/{docs => }/comty-js/models/auth/change-password.md (100%) rename docs/{docs => }/comty-js/models/auth/login.md (100%) rename docs/{docs => }/comty-js/models/auth/logout.md (100%) rename docs/{docs => }/comty-js/models/auth/register.md (100%) rename docs/{docs => }/comty-js/models/auth/user-validation.md (100%) rename docs/{docs => }/comty-js/models/chats.md (100%) rename docs/{docs => }/comty-js/models/feed.md (100%) rename docs/{docs => }/comty-js/models/follows/_category_.json (100%) rename docs/{docs => }/comty-js/models/follows/im-following.md (100%) rename docs/{docs => }/comty-js/models/music.md (100%) rename docs/{docs => }/comty-js/models/nfc.md (100%) rename docs/{docs => }/comty-js/models/post/_category_.json (100%) rename docs/{docs => }/comty-js/models/post/create-post.md (100%) rename docs/{docs => }/comty-js/models/post/delete-post.md (100%) rename docs/{docs => }/comty-js/models/post/get-my-liked-posts.md (100%) rename docs/{docs => }/comty-js/models/post/get-post-data.md (100%) rename docs/{docs => }/comty-js/models/post/get-post-replies.md (100%) rename docs/{docs => }/comty-js/models/post/get-saved-posts.md (100%) rename docs/{docs => }/comty-js/models/post/get-user-posts.md (100%) rename docs/{docs => }/comty-js/models/post/toggle-like.md (100%) rename docs/{docs => }/comty-js/models/post/toggle-save.md (100%) rename docs/{docs => }/comty-js/models/post/update-post.md (100%) rename docs/{docs => }/comty-js/models/search.md (100%) rename docs/{docs => }/comty-js/models/session.md (100%) rename docs/{docs => }/comty-js/models/user.md (100%) create mode 100644 docs/development/_category_.json create mode 100644 docs/development/getting-started.md delete mode 100644 docs/docs/client-sdk/_category_.json delete mode 100644 docs/docs/client-sdk/getting-started.md delete mode 100644 docs/docs/comty-cli/_category_.json delete mode 100644 docs/docs/comty-cli/getting-started.md delete mode 100644 docs/docs/comty-js/_category_.json delete mode 100644 docs/docs/comty-js/installing.md delete mode 100644 docs/docs/spectrum-api/_category_.json delete mode 100644 docs/docs/spectrum-api/getting-started.md delete mode 100644 docs/legal/tos.md rename {docs => docusaurus}/.gitignore (100%) rename {docs => docusaurus}/README.md (100%) rename {docs => docusaurus}/babel.config.js (100%) rename {docs => docusaurus}/docusaurus.config.js (92%) rename {docs => docusaurus}/package.json (100%) rename {docs => docusaurus}/sidebars.js (65%) rename {docs => docusaurus}/src/components/HomepageFeatures/index.js (100%) rename {docs => docusaurus}/src/components/HomepageFeatures/styles.module.css (100%) rename {docs => docusaurus}/src/css/custom.css (100%) rename {docs => docusaurus}/src/pages/index.js (100%) rename {docs => docusaurus}/src/pages/index.module.css (100%) rename {docs => docusaurus}/src/pages/markdown-page.md (100%) rename {docs => docusaurus}/static/.nojekyll (100%) rename {docs => docusaurus}/static/img/docusaurus-social-card.jpg (100%) rename {docs => docusaurus}/static/img/docusaurus.png (100%) rename {docs => docusaurus}/static/img/favicon.ico (100%) rename {docs => docusaurus}/static/img/logo.svg (100%) rename {docs => docusaurus}/static/img/undraw_docusaurus_mountain.svg (100%) rename {docs => docusaurus}/static/img/undraw_docusaurus_react.svg (100%) rename {docs => docusaurus}/static/img/undraw_docusaurus_tree.svg (100%) diff --git a/docs/comty-cli/_category_.json b/docs/comty-cli/_category_.json new file mode 100644 index 00000000..f4702777 --- /dev/null +++ b/docs/comty-cli/_category_.json @@ -0,0 +1,7 @@ +{ + "label": "Comty CLI", + "position": 3, + "link": { + "type": "generated-index" + } +} diff --git a/docs/docs/comty-js/getting-started.md b/docs/comty-cli/getting-started.md similarity index 71% rename from docs/docs/comty-js/getting-started.md rename to docs/comty-cli/getting-started.md index a736f04d..ca6b2822 100644 --- a/docs/docs/comty-js/getting-started.md +++ b/docs/comty-cli/getting-started.md @@ -3,4 +3,3 @@ sidebar_position: 1 --- # Getting Started -Me pica el splungus \ No newline at end of file diff --git a/docs/comty-js/_category_.json b/docs/comty-js/_category_.json new file mode 100644 index 00000000..6441a675 --- /dev/null +++ b/docs/comty-js/_category_.json @@ -0,0 +1,7 @@ +{ + "label": "Comty.JS", + "position": 2, + "link": { + "type": "generated-index" + } +} diff --git a/docs/docs/comty-js/authentication.md b/docs/comty-js/authentication.md similarity index 100% rename from docs/docs/comty-js/authentication.md rename to docs/comty-js/authentication.md diff --git a/docs/docs/comty-js/definitions/_category_.json b/docs/comty-js/definitions/_category_.json similarity index 100% rename from docs/docs/comty-js/definitions/_category_.json rename to docs/comty-js/definitions/_category_.json diff --git a/docs/docs/comty-js/definitions/like-status-object.md b/docs/comty-js/definitions/like-status-object.md similarity index 100% rename from docs/docs/comty-js/definitions/like-status-object.md rename to docs/comty-js/definitions/like-status-object.md diff --git a/docs/docs/comty-js/definitions/post-object.md b/docs/comty-js/definitions/post-object.md similarity index 100% rename from docs/docs/comty-js/definitions/post-object.md rename to docs/comty-js/definitions/post-object.md diff --git a/docs/docs/comty-js/definitions/save-status-object.md b/docs/comty-js/definitions/save-status-object.md similarity index 100% rename from docs/docs/comty-js/definitions/save-status-object.md rename to docs/comty-js/definitions/save-status-object.md diff --git a/docs/comty-js/getting-started.md b/docs/comty-js/getting-started.md new file mode 100644 index 00000000..0d156ab7 --- /dev/null +++ b/docs/comty-js/getting-started.md @@ -0,0 +1,37 @@ +--- +sidebar_position: 1 +--- + +# Getting Started with Comty.JS +[https://github.com/ragestudio/comty.js](https://github.com/ragestudio/comty.js) + +Welcome to Comty.JS, the official JavaScript library for interacting with the Comty API! This library is designed to simplify communication with Comty services, whether you're building a server-side application or a client-side interface. + +## What is Comty.JS? + +Comty.JS provides a convenient wrapper around the Comty API, handling authentication, request management, real-time communication via WebSockets, and more. It aims to make your development process smoother and more efficient by abstracting away the complexities of direct API interaction. + +**Key Features:** + +- **Simplified API Access:** Easy-to-use models for various Comty services like Authentication, Posts, User Management, Music, Chats, and more. +- **Authentication Handling:** Built-in support for server keys and user token-based authentication, including automatic token refresh. +- **WebSocket Integration:** Seamlessly connect to Comty's real-time services. +- **Addon System:** Extend the library's functionality with custom addons. +- **Environment Aware:** Works in both Node.js (server-side) and browser (client-side) environments. +- **Request Management:** Uses `axios` for HTTP requests with interceptors for automatic token attachment and error handling. + +## Who is this for? + +This library is for developers who want to: + +- Integrate their JavaScript or TypeScript applications with Comty. +- Build features that utilize Comty's social, music, or other platform functionalities. +- Quickly set up communication with the Comty API without dealing with raw HTTP requests and WebSocket management. + +## Next Steps + +1. **[Installing Comty.JS](./installing.md)**: Learn how to add the library to your project. +2. **[Client Initialization](./client-initialization.md)**: Understand how to set up and configure the Comty.JS client. +3. **[Authentication](./authentication.md)**: Dive into how authentication works with Comty.JS. + +We're excited to see what you build with Comty.JS! diff --git a/docs/comty-js/installing.md b/docs/comty-js/installing.md new file mode 100644 index 00000000..421008ad --- /dev/null +++ b/docs/comty-js/installing.md @@ -0,0 +1,103 @@ +--- +sidebar_position: 2 +--- + +# Installing Comty.JS + +To get started with Comty.JS, you need to add it as a dependency to your project. The library is available on npm. + +## Prerequisites + +* Node.js (version 12 or higher recommended, as per `jsonwebtoken` and `sucrase` dependencies) +* A package manager like npm or Yarn + +## Installation + +You can install Comty.JS using either npm or Yarn: + +### Using npm + +```bash +npm install comty.js +``` + +### Using Yarn + +```bash +yarn add comty.js +``` + +This will download Comty.JS and add it to your project's `node_modules` directory. The following dependencies will also be installed: + +* `@foxify/events`: ^2.1.0 +* `axios`: ^1.8.4 +* `js-cookie`: ^3.0.5 +* `jsonwebtoken`: ^9.0.0 +* `jwt-decode`: ^4.0.0 +* `linebridge-client`: ^1.1.1 +* `luxon`: ^3.6.0 +* `socket.io-client`: ^4.8.1 + +For development, if you plan to contribute or build the library locally, you'll also need: + +* `@ragestudio/hermes`: ^1.0.1 (used for building the project) + +## Importing the library + +Once installed, you can import Comty.JS into your project: + +### ES Modules (JavaScript or TypeScript) + +```javascript +import createClient from 'comty.js'; +// or for specific models if needed (though typically client is the main entry) +// import { AuthModel, PostModel } from 'comty.js/models'; // Adjust path based on actual export structure if modular imports are supported +``` + +### CommonJS (Node.js) + +```javascript +const createClient = require('comty.js'); +// or for specific models +// const { AuthModel, PostModel } = require('comty.js/models'); // Adjust path +``` + +If you look at the `package.json`, the main entry point is `"./dist/index.js"`. + +```json comty-project/public-repo/comty.js/package.json#L3 +{ + "name": "comty.js", + "version": "0.65.5", + "main": "./dist/index.js", + "description": "Official Comty API for JavaScript", + "homepage": "https://github.com/ragestudio/comty.js", + "author": "RageStudio ", + "scripts": { + "build": "hermes build" + }, + "files": [ + "dist" + ], + "license": "MIT", + "dependencies": { + "@foxify/events": "^2.1.0", + "axios": "^1.8.4", + "js-cookie": "^3.0.5", + "jsonwebtoken": "^9.0.0", + "jwt-decode": "^4.0.0", + "linebridge-client": "^1.1.1", + "luxon": "^3.6.0", + "socket.io-client": "^4.8.1" + }, + "devDependencies": { + "@ragestudio/hermes": "^1.0.1" + } +} + +``` + +Now you're ready to initialize the client and start interacting with the Comty API. + +## Next Steps + +* **[Client Initialization](./client-initialization.md)**: Learn how to set up and configure the Comty.JS client. \ No newline at end of file diff --git a/docs/docs/comty-js/models/_category_.json b/docs/comty-js/models/_category_.json similarity index 100% rename from docs/docs/comty-js/models/_category_.json rename to docs/comty-js/models/_category_.json diff --git a/docs/docs/comty-js/models/auth/_category_.json b/docs/comty-js/models/auth/_category_.json similarity index 100% rename from docs/docs/comty-js/models/auth/_category_.json rename to docs/comty-js/models/auth/_category_.json diff --git a/docs/docs/comty-js/models/auth/availability.md b/docs/comty-js/models/auth/availability.md similarity index 100% rename from docs/docs/comty-js/models/auth/availability.md rename to docs/comty-js/models/auth/availability.md diff --git a/docs/docs/comty-js/models/auth/change-password.md b/docs/comty-js/models/auth/change-password.md similarity index 100% rename from docs/docs/comty-js/models/auth/change-password.md rename to docs/comty-js/models/auth/change-password.md diff --git a/docs/docs/comty-js/models/auth/login.md b/docs/comty-js/models/auth/login.md similarity index 100% rename from docs/docs/comty-js/models/auth/login.md rename to docs/comty-js/models/auth/login.md diff --git a/docs/docs/comty-js/models/auth/logout.md b/docs/comty-js/models/auth/logout.md similarity index 100% rename from docs/docs/comty-js/models/auth/logout.md rename to docs/comty-js/models/auth/logout.md diff --git a/docs/docs/comty-js/models/auth/register.md b/docs/comty-js/models/auth/register.md similarity index 100% rename from docs/docs/comty-js/models/auth/register.md rename to docs/comty-js/models/auth/register.md diff --git a/docs/docs/comty-js/models/auth/user-validation.md b/docs/comty-js/models/auth/user-validation.md similarity index 100% rename from docs/docs/comty-js/models/auth/user-validation.md rename to docs/comty-js/models/auth/user-validation.md diff --git a/docs/docs/comty-js/models/chats.md b/docs/comty-js/models/chats.md similarity index 100% rename from docs/docs/comty-js/models/chats.md rename to docs/comty-js/models/chats.md diff --git a/docs/docs/comty-js/models/feed.md b/docs/comty-js/models/feed.md similarity index 100% rename from docs/docs/comty-js/models/feed.md rename to docs/comty-js/models/feed.md diff --git a/docs/docs/comty-js/models/follows/_category_.json b/docs/comty-js/models/follows/_category_.json similarity index 100% rename from docs/docs/comty-js/models/follows/_category_.json rename to docs/comty-js/models/follows/_category_.json diff --git a/docs/docs/comty-js/models/follows/im-following.md b/docs/comty-js/models/follows/im-following.md similarity index 100% rename from docs/docs/comty-js/models/follows/im-following.md rename to docs/comty-js/models/follows/im-following.md diff --git a/docs/docs/comty-js/models/music.md b/docs/comty-js/models/music.md similarity index 100% rename from docs/docs/comty-js/models/music.md rename to docs/comty-js/models/music.md diff --git a/docs/docs/comty-js/models/nfc.md b/docs/comty-js/models/nfc.md similarity index 100% rename from docs/docs/comty-js/models/nfc.md rename to docs/comty-js/models/nfc.md diff --git a/docs/docs/comty-js/models/post/_category_.json b/docs/comty-js/models/post/_category_.json similarity index 100% rename from docs/docs/comty-js/models/post/_category_.json rename to docs/comty-js/models/post/_category_.json diff --git a/docs/docs/comty-js/models/post/create-post.md b/docs/comty-js/models/post/create-post.md similarity index 100% rename from docs/docs/comty-js/models/post/create-post.md rename to docs/comty-js/models/post/create-post.md diff --git a/docs/docs/comty-js/models/post/delete-post.md b/docs/comty-js/models/post/delete-post.md similarity index 100% rename from docs/docs/comty-js/models/post/delete-post.md rename to docs/comty-js/models/post/delete-post.md diff --git a/docs/docs/comty-js/models/post/get-my-liked-posts.md b/docs/comty-js/models/post/get-my-liked-posts.md similarity index 100% rename from docs/docs/comty-js/models/post/get-my-liked-posts.md rename to docs/comty-js/models/post/get-my-liked-posts.md diff --git a/docs/docs/comty-js/models/post/get-post-data.md b/docs/comty-js/models/post/get-post-data.md similarity index 100% rename from docs/docs/comty-js/models/post/get-post-data.md rename to docs/comty-js/models/post/get-post-data.md diff --git a/docs/docs/comty-js/models/post/get-post-replies.md b/docs/comty-js/models/post/get-post-replies.md similarity index 100% rename from docs/docs/comty-js/models/post/get-post-replies.md rename to docs/comty-js/models/post/get-post-replies.md diff --git a/docs/docs/comty-js/models/post/get-saved-posts.md b/docs/comty-js/models/post/get-saved-posts.md similarity index 100% rename from docs/docs/comty-js/models/post/get-saved-posts.md rename to docs/comty-js/models/post/get-saved-posts.md diff --git a/docs/docs/comty-js/models/post/get-user-posts.md b/docs/comty-js/models/post/get-user-posts.md similarity index 100% rename from docs/docs/comty-js/models/post/get-user-posts.md rename to docs/comty-js/models/post/get-user-posts.md diff --git a/docs/docs/comty-js/models/post/toggle-like.md b/docs/comty-js/models/post/toggle-like.md similarity index 100% rename from docs/docs/comty-js/models/post/toggle-like.md rename to docs/comty-js/models/post/toggle-like.md diff --git a/docs/docs/comty-js/models/post/toggle-save.md b/docs/comty-js/models/post/toggle-save.md similarity index 100% rename from docs/docs/comty-js/models/post/toggle-save.md rename to docs/comty-js/models/post/toggle-save.md diff --git a/docs/docs/comty-js/models/post/update-post.md b/docs/comty-js/models/post/update-post.md similarity index 100% rename from docs/docs/comty-js/models/post/update-post.md rename to docs/comty-js/models/post/update-post.md diff --git a/docs/docs/comty-js/models/search.md b/docs/comty-js/models/search.md similarity index 100% rename from docs/docs/comty-js/models/search.md rename to docs/comty-js/models/search.md diff --git a/docs/docs/comty-js/models/session.md b/docs/comty-js/models/session.md similarity index 100% rename from docs/docs/comty-js/models/session.md rename to docs/comty-js/models/session.md diff --git a/docs/docs/comty-js/models/user.md b/docs/comty-js/models/user.md similarity index 100% rename from docs/docs/comty-js/models/user.md rename to docs/comty-js/models/user.md diff --git a/docs/development/_category_.json b/docs/development/_category_.json new file mode 100644 index 00000000..480e1cc2 --- /dev/null +++ b/docs/development/_category_.json @@ -0,0 +1,7 @@ +{ + "label": "Development", + "position": 1, + "link": { + "type": "generated-index" + } +} diff --git a/docs/development/getting-started.md b/docs/development/getting-started.md new file mode 100644 index 00000000..514ee750 --- /dev/null +++ b/docs/development/getting-started.md @@ -0,0 +1,64 @@ +--- +sidebar_position: 1 +--- +# Getting Started +We strongly recommend using Linux or macOS for development. Other platforms, such as Windows, can cause multiple issues. + +Using Docker dev containers is also a nice choice. + +## Dependencies +- Node.js (v18 or higher) +> Install [manually](https://nodejs.org/en/download/) or use [nvm](https://github.com/nvm-sh/nvm) tool (or similar tools). + +- Python (3.10 or higher) + +- [node-gyp](https://github.com/nodejs/node-gyp#installation) Install globally `npm install -g node-gyp` + +- FFmpeg & FFprobe (^6.0 or higher) +> On Linux you can use built-in script to install it in your system-wide `packages/server/scripts/installLatestFfmpeg.sh` (uses CURL) + +- (Recomended) Use [npm](https://docs.npmjs.com/cli/v11/configuring-npm/install) package manager. + +- (Optional) [Docker](https://docs.docker.com/get-docker/), used for develop/building/deploy. + +## Getting files +- Getting the repository +```shell +git clone --recurse-submodules https://github.com/ragestudio/comty && cd comty +``` + +- Installing all dependencies +```shell +npm install +``` + +## Setup Gateway +Comty uses a custom gateway to handle all requests and manage backend services. This gateway has two available engines for serving requests: +- `nginx`: Currently recommended. +- `http_proxy`: Obsolete, used in previous versions. Probably broken. + +You can select an available engine by setting the `GATEWAY_MODE=""` environment variable. This can also be declared in the `.env` file. + +By default, the gateway uses NGINX (as a proxy) to handle requests, so you'll need to set up this dependency. + +It can be installed system-wide or by linking a static binary to `packages/server/nginx-bin` + +> On Linux you can use built-in script to statically install +`packages/server/scripts/installNginxStatic.sh` (needs CURL) + +## First Setup +This will execute some tasks to initialize for first time your resources, like S3, Databases...etc. +If you already initialized previously, skip this step. + +- Run server setup script (if needed) +```shell +npm run setup:server +``` + +Also can you use the `--force` flag to force the execution of this tasks again. + +### Starting the development server +- You can use the command `npm run dev` to start all development servers. +```shell +npm run dev +``` diff --git a/docs/docs/client-sdk/_category_.json b/docs/docs/client-sdk/_category_.json deleted file mode 100644 index 144d6f39..00000000 --- a/docs/docs/client-sdk/_category_.json +++ /dev/null @@ -1,7 +0,0 @@ -{ - "label": "Client SDK", - "position": 2, - "link": { - "type": "generated-index" - } -} diff --git a/docs/docs/client-sdk/getting-started.md b/docs/docs/client-sdk/getting-started.md deleted file mode 100644 index a736f04d..00000000 --- a/docs/docs/client-sdk/getting-started.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Getting Started -Me pica el splungus \ No newline at end of file diff --git a/docs/docs/comty-cli/_category_.json b/docs/docs/comty-cli/_category_.json deleted file mode 100644 index f275b2a1..00000000 --- a/docs/docs/comty-cli/_category_.json +++ /dev/null @@ -1,7 +0,0 @@ -{ - "label": "Comty™ CLI", - "position": 3, - "link": { - "type": "generated-index" - } -} diff --git a/docs/docs/comty-cli/getting-started.md b/docs/docs/comty-cli/getting-started.md deleted file mode 100644 index a736f04d..00000000 --- a/docs/docs/comty-cli/getting-started.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Getting Started -Me pica el splungus \ No newline at end of file diff --git a/docs/docs/comty-js/_category_.json b/docs/docs/comty-js/_category_.json deleted file mode 100644 index 5576be2b..00000000 --- a/docs/docs/comty-js/_category_.json +++ /dev/null @@ -1,7 +0,0 @@ -{ - "label": "Comty.JS", - "position": 1, - "link": { - "type": "generated-index" - } -} diff --git a/docs/docs/comty-js/installing.md b/docs/docs/comty-js/installing.md deleted file mode 100644 index 85592d8b..00000000 --- a/docs/docs/comty-js/installing.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Installing \ No newline at end of file diff --git a/docs/docs/spectrum-api/_category_.json b/docs/docs/spectrum-api/_category_.json deleted file mode 100644 index 6ab5187c..00000000 --- a/docs/docs/spectrum-api/_category_.json +++ /dev/null @@ -1,7 +0,0 @@ -{ - "label": "Spectrum™ API", - "position": 4, - "link": { - "type": "generated-index" - } -} diff --git a/docs/docs/spectrum-api/getting-started.md b/docs/docs/spectrum-api/getting-started.md deleted file mode 100644 index a736f04d..00000000 --- a/docs/docs/spectrum-api/getting-started.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Getting Started -Me pica el splungus \ No newline at end of file diff --git a/docs/legal/tos.md b/docs/legal/tos.md deleted file mode 100644 index d33889c5..00000000 --- a/docs/legal/tos.md +++ /dev/null @@ -1 +0,0 @@ -# Meet or TOS \ No newline at end of file diff --git a/docs/.gitignore b/docusaurus/.gitignore similarity index 100% rename from docs/.gitignore rename to docusaurus/.gitignore diff --git a/docs/README.md b/docusaurus/README.md similarity index 100% rename from docs/README.md rename to docusaurus/README.md diff --git a/docs/babel.config.js b/docusaurus/babel.config.js similarity index 100% rename from docs/babel.config.js rename to docusaurus/babel.config.js diff --git a/docs/docusaurus.config.js b/docusaurus/docusaurus.config.js similarity index 92% rename from docs/docusaurus.config.js rename to docusaurus/docusaurus.config.js index bb89c927..767a3f28 100644 --- a/docs/docusaurus.config.js +++ b/docusaurus/docusaurus.config.js @@ -40,6 +40,7 @@ const config = { /** @type {import("@docusaurus/preset-classic").Options} */ ({ docs: { + path: "../docs", sidebarPath: "./sidebars.js", //editUrl: "https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/", }, @@ -68,12 +69,12 @@ const config = { position: "left", label: "Docs", }, - { - type: "docSidebar", - sidebarId: "legal", - position: "left", - label: "Legal", - }, + // { + // type: "docSidebar", + // sidebarId: "legal", + // position: "left", + // label: "Legal", + // }, { href: "https://github.com/ragestudio/comty", label: "GitHub", @@ -98,7 +99,7 @@ const config = { { label: "Comty", href: "https://comty.app/@ragestudio", - } + }, ], }, ], @@ -108,6 +109,9 @@ const config = { theme: prismThemes.github, darkTheme: prismThemes.dracula, }, + colorMode: { + defaultMode: "dark", + }, }), } diff --git a/docs/package.json b/docusaurus/package.json similarity index 100% rename from docs/package.json rename to docusaurus/package.json diff --git a/docs/sidebars.js b/docusaurus/sidebars.js similarity index 65% rename from docs/sidebars.js rename to docusaurus/sidebars.js index 02a5810c..77b13f1f 100644 --- a/docs/sidebars.js +++ b/docusaurus/sidebars.js @@ -13,9 +13,8 @@ /** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */ const sidebars = { - // By default, Docusaurus generates a sidebar from the docs folder structure - docs: [{type: 'autogenerated', dirName: '.'}], - legal: [{type: 'autogenerated', dirName: '.'}], + // By default, Docusaurus generates a sidebar from the docs folder structure + docs: [{ type: "autogenerated", dirName: "." }], } -export default sidebars; +export default sidebars diff --git a/docs/src/components/HomepageFeatures/index.js b/docusaurus/src/components/HomepageFeatures/index.js similarity index 100% rename from docs/src/components/HomepageFeatures/index.js rename to docusaurus/src/components/HomepageFeatures/index.js diff --git a/docs/src/components/HomepageFeatures/styles.module.css b/docusaurus/src/components/HomepageFeatures/styles.module.css similarity index 100% rename from docs/src/components/HomepageFeatures/styles.module.css rename to docusaurus/src/components/HomepageFeatures/styles.module.css diff --git a/docs/src/css/custom.css b/docusaurus/src/css/custom.css similarity index 100% rename from docs/src/css/custom.css rename to docusaurus/src/css/custom.css diff --git a/docs/src/pages/index.js b/docusaurus/src/pages/index.js similarity index 100% rename from docs/src/pages/index.js rename to docusaurus/src/pages/index.js diff --git a/docs/src/pages/index.module.css b/docusaurus/src/pages/index.module.css similarity index 100% rename from docs/src/pages/index.module.css rename to docusaurus/src/pages/index.module.css diff --git a/docs/src/pages/markdown-page.md b/docusaurus/src/pages/markdown-page.md similarity index 100% rename from docs/src/pages/markdown-page.md rename to docusaurus/src/pages/markdown-page.md diff --git a/docs/static/.nojekyll b/docusaurus/static/.nojekyll similarity index 100% rename from docs/static/.nojekyll rename to docusaurus/static/.nojekyll diff --git a/docs/static/img/docusaurus-social-card.jpg b/docusaurus/static/img/docusaurus-social-card.jpg similarity index 100% rename from docs/static/img/docusaurus-social-card.jpg rename to docusaurus/static/img/docusaurus-social-card.jpg diff --git a/docs/static/img/docusaurus.png b/docusaurus/static/img/docusaurus.png similarity index 100% rename from docs/static/img/docusaurus.png rename to docusaurus/static/img/docusaurus.png diff --git a/docs/static/img/favicon.ico b/docusaurus/static/img/favicon.ico similarity index 100% rename from docs/static/img/favicon.ico rename to docusaurus/static/img/favicon.ico diff --git a/docs/static/img/logo.svg b/docusaurus/static/img/logo.svg similarity index 100% rename from docs/static/img/logo.svg rename to docusaurus/static/img/logo.svg diff --git a/docs/static/img/undraw_docusaurus_mountain.svg b/docusaurus/static/img/undraw_docusaurus_mountain.svg similarity index 100% rename from docs/static/img/undraw_docusaurus_mountain.svg rename to docusaurus/static/img/undraw_docusaurus_mountain.svg diff --git a/docs/static/img/undraw_docusaurus_react.svg b/docusaurus/static/img/undraw_docusaurus_react.svg similarity index 100% rename from docs/static/img/undraw_docusaurus_react.svg rename to docusaurus/static/img/undraw_docusaurus_react.svg diff --git a/docs/static/img/undraw_docusaurus_tree.svg b/docusaurus/static/img/undraw_docusaurus_tree.svg similarity index 100% rename from docs/static/img/undraw_docusaurus_tree.svg rename to docusaurus/static/img/undraw_docusaurus_tree.svg