refactor: documentation enhancements & move to turbo (#111)

Author: MihalyToth20

.changeset/eight-states-hear.md

@@ -0,0 +1,8 @@
+---
+'@calycode/core': patch
+'@calycode/cli': patch
+---
+
+feat: improvements to the documentation generation, added changelog links, full-text search, pagination plugin, terminaly plugin, flexible callouts plugin, dark mode support and mermaid support plugins
+refactor: rearranged the repo to be more like a proper turbo powered monorepo. Build times are much faster as before...
+refactor: adjustments to the github workflows to match turborepo (without remote cache)

.github/workflows/add-docs-to-release.yml

@@ -24,16 +24,22 @@ jobs:
       - uses: actions/setup-node@v4
         with:
           node-version: 20.x
+          cache: 'pnpm'
 
       - name: Install packages
-        run: pnpm install
+        run: pnpm install --frozen-lockfile
 
       - name: Build packages
-        run: pnpm build:packages
+        run: pnpm build
 
       - name: Build Docs
         run: pnpm build:docs
 
+      - name: Add GH Identity
+        run: |
+          git config --global user.email "[email protected]"
+          git config --global user.name "Mihály Tóth"
+
       - name: Commit docs
         id: commit_docs
         run: |
@@ -52,4 +58,3 @@ jobs:
           git config user.name "github-actions[bot]"
           git config user.email "github-actions[bot]@users.noreply.github.com"
           git push origin HEAD:${GITHUB_HEAD_REF} --force-with-lease
-

.github/workflows/release.yml

@@ -26,25 +26,26 @@ jobs:
            uses: actions/setup-node@v4
            with:
               node-version: 20.x
+              cache: 'pnpm'
               registry-url: 'https://registry.npmjs.org'
               scope: '@calycode'
               always-auth: true
            env:
               NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
 
          - name: Install dependencies
-           run: pnpm install
+           run: pnpm install --frozen-lockfile
 
          - name: Build packages
-           run: pnpm build:packages
+           run: pnpm build
 
          - name: Publish to npm
            id: changesets
            uses: changesets/action@v1
            with:
               commit: 'changeset-release'
               title: 'Release Version'
-              publish: pnpm -r publish --access restricted
+              publish: pnpm -r publish
            env:
               GITHUB_TOKEN: ${{ secrets.CHANGESETS_GH_TOKEN }}
               NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

.github/workflows/upload-docs.yml

@@ -22,17 +22,15 @@ jobs:
            uses: actions/setup-node@v4
            with:
               node-version: 20.x
+              cache: 'pnpm'
               registry-url: 'https://registry.npmjs.org'
               scope: '@calycode'
               always-auth: true
            env:
               NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
 
          - name: Install dependencies
-           run: pnpm install
-
-         - name: Build packages
-           run: pnpm build:packages
+           run: pnpm install --frozen-lockfile
 
          - name: Update the docs
            run: pnpm build:docs

.gitignore

@@ -30,3 +30,5 @@ project-plan.md
 *.tsbuildinfo
 calyInstance.config.js
 calyInstance.test.setup.json
+
+**/.turbo/

docs/_media/logo.png

@@ -1,11 +1,10 @@
--  ### Core Commands:
+- Core command
 
    -  [xano - the core command](xano.md)
 
--  ### Features
+-  Commands
 
    -  [`setup`](commands/setup.md)
-   -  [`switch-context`](commands/switch-context.md)
    -  [`generate-oas`](commands/generate-oas.md)
    -  [`serve-oas`](commands/serve-oas.md)
    -  [`generate-code`](commands/generate-code.md)
@@ -19,8 +18,11 @@
    -  [`run-test`](commands/run-test.md)
    -  [`current-context`](commands/current-context.md)
 
----
+- Changelog
 
-<small>Made with💖by the [OSOI.IO](https://osoi.io) Team</small>
+   - [CLI](https://github.com/calycode/xano-tools/blob/main/packages/cli/CHANGELOG.md)
+   - [CORE](https://github.com/calycode/xano-tools/blob/main/packages/core/CHANGELOG.md)
 
+
+<small>For devs with 💖 by devs at [calycode](https://calycode.com).</small>
 <small>Documentation powered by [Docsify.js](https://docsifyjs.org)</small>

docs/_sidebar.md

@@ -1,12 +1,13 @@
 # current-context
-```sh
-xano current-context [options]
+```term
+$ xano current-context [options]
 ```
 ### Options
 
 
 ### current-context --help
-```sh
+```term
+$ xano current-context --help
 Usage: xano current-context [options]
 
 Options:

docs/commands/current-context.md

@@ -1,8 +1,9 @@
 # export-backup
+>[!NOTE|label:Description]
 > #### Backup Xano Workspace via Metadata API
 
-```sh
-xano export-backup [options]
+```term
+$ xano export-backup [options]
 ```
 ### Options
 
@@ -16,19 +17,16 @@ xano export-backup [options]
 **Description:** Expose usable output path for further reuse.
 
 ### export-backup --help
-```sh
+```term
+$ xano export-backup --help
 Usage: xano export-backup [options]
 
 Backup Xano Workspace via Metadata API
 
 Options:
-  --instance <instance>    The instance name. This is used to fetch the instance
-                           configuration. The value provided at the setup
-                           command.
-  --workspace <workspace>  The workspace name. This is used to fetch the
-                           workspace configuration. Same as on Xano interface.
-  --branch <branch>        The branch name. This is used to select the branch
-                           configuration. Same as on Xano Interface.
+  --instance <instance>    The instance name. This is used to fetch the instance configuration. The value provided at the setup command.
+  --workspace <workspace>  The workspace name. This is used to fetch the workspace configuration. Same as on Xano interface.
+  --branch <branch>        The branch name. This is used to select the branch configuration. Same as on Xano Interface.
   --print-output-dir       Expose usable output path for further reuse.
   -h, --help               display help for command
 ```

docs/commands/export-backup.md

@@ -1,8 +1,9 @@
 # generate-code
+>[!NOTE|label:Description]
 > #### Create a library based on the OpenAPI specification. If the openapi specification has not yet been generated, this will generate that as well as the first step.
 
-```sh
-xano generate-code [options]
+```term
+$ xano generate-code [options]
 ```
 ### Options
 
@@ -26,30 +27,21 @@ xano generate-code [options]
 **Description:** Specify this flag in order to allow logging. Logs will appear in output/_logs. Default: false
 
 ### generate-code --help
-```sh
+```term
+$ xano generate-code --help
 Usage: xano generate-code [options]
 
-Create a library based on the OpenAPI specification. If the openapi
-specification has not yet been generated, this will generate that as well as the
-first step.
+Create a library based on the OpenAPI specification. If the openapi specification has not yet been generated, this will generate that as well as the first step.
 
 Options:
-  --instance <instance>    The instance name. This is used to fetch the instance
-                           configuration. The value provided at the setup
-                           command.
-  --workspace <workspace>  The workspace name. This is used to fetch the
-                           workspace configuration. Same as on Xano interface.
-  --branch <branch>        The branch name. This is used to select the branch
-                           configuration. Same as on Xano Interface.
+  --instance <instance>    The instance name. This is used to fetch the instance configuration. The value provided at the setup command.
+  --workspace <workspace>  The workspace name. This is used to fetch the workspace configuration. Same as on Xano interface.
+  --branch <branch>        The branch name. This is used to select the branch configuration. Same as on Xano Interface.
   --group <name>           API group name. Same as on Xano Interface.
-  --all                    Regenerate for all API groups in the workspace /
-                           branch of the current context.
+  --all                    Regenerate for all API groups in the workspace / branch of the current context.
   --print-output-dir       Expose usable output path for further reuse.
-  --generator <generator>  Generator to use, see all options at:
-                           https://openapi-generator.tech/docs/generators
-  --args <args>            Additional arguments to pass to the generator. See
-                           https://openapi-generator.tech/docs/usage#generate
-  --debug                  Specify this flag in order to allow logging. Logs
-                           will appear in output/_logs. Default: false
+  --generator <generator>  Generator to use, see all options at: https://openapi-generator.tech/docs/generators
+  --args <args>            Additional arguments to pass to the generator. See https://openapi-generator.tech/docs/usage#generate
+  --debug                  Specify this flag in order to allow logging. Logs will appear in output/_logs. Default: false
   -h, --help               display help for command
 ```