feat: new docs framework (#154)

How to migrate:

- set up the folder structure
- remove any numbers from the file names make then similar (kebab-case)
- fix the frontmatter (see
https://fumadocs.vercel.app/docs/ui/markdown#frontmatter)
- put the images used in the folder itself in an assets folder, then fix
the urls
- replace all custom components with native components 
  - https://fumadocs.vercel.app/docs/ui/markdown#mdx
  - https://fumadocs.vercel.app/docs/ui/components/accordion etc
  - https://fumadocs.vercel.app/docs/ui/mdx
  - https://fumadocs.vercel.app/docs/headless/mdx/install
  - schematics via https://fumadocs.vercel.app/docs/ui/mermaid
- ordering etc via
https://fumadocs.vercel.app/docs/ui/page-conventions#meta
  
While migrating, take note of the wordings:

- All out things together are "SettleMint"
- The platform is called SettleMint Platform 
- SettleMint SDK and SettleMint CLI
- Asset Tokenization Kit

To run:
- clone
- bun i
- bun dev
- http://localhost:3000/documentation

---------

Co-authored-by: saeeddawod <saeed.dawod@gmail.com>

Author: roderik

.bun-version

@@ -0,0 +1 @@
+1.2.2

.dockerignore

@@ -1,3 +1,6 @@
 node_modules
-coverage
-test
+.git
+.gitignore
+.next
+out
+bun.l*

.eslintrc.json

@@ -0,0 +1,3 @@
+{
+  "extends": ["next/core-web-vitals", "next/typescript"]
+}

.github/workflows/branch.yml

@@ -43,9 +43,6 @@ jobs:
         with:
           fetch-depth: 2
 
-      - name: Install Cosign
-        uses: sigstore/cosign-installer@v3
-
       - name: Install Node.js
         uses: actions/setup-node@v4
         with:
@@ -55,19 +52,18 @@ jobs:
       - name: Install Node.js
         uses: actions/setup-node@1d0ff469b7ec7b3cb9d8673fde0c81c44821de2a # v4
         with:
-          node-version-file: package.json
+          node-version-file: .nvmrc
           token: ${{ secrets.GITHUB_TOKEN }}
 
       - name: Setup caches
         uses: namespacelabs/nscloud-cache-action@1d016dd6d40428050a16a6271307888386cc0bec # v1
         with:
           path: |
-            .turbo
             ~/.bun/install/cache
 
       - uses: oven-sh/setup-bun@4bc047ad259df6fc24a6c9b0f9a0cb08cf17fbe5 # v2
         with:
-          bun-version-file: package.json
+          bun-version-file: .bun-version
 
       - name: Login to GitHub Container Registry
         uses: docker/login-action@v3
@@ -106,8 +102,4 @@ jobs:
 
       - name: Build Docker container
         run: |
-          bun run docker
-
-      - name: Cosign Docker container
-        run: |
-          bun run cosign
+          bun run docker

.gitignore

@@ -1,20 +1,28 @@
-# Dependencies
+# deps
 /node_modules
 
-# Production
-/build
+# generated content
+.contentlayer
+.content-collections
+.source
 
-# Generated files
-.docusaurus
-.cache-loader
+# test & build
+/coverage
+/.next/
+/out/
+/build
+*.tsbuildinfo
 
-# Misc
+# misc
 .DS_Store
-.env.local
-.env.development.local
-.env.test.local
-.env.production.local
-
+*.pem
+/.pnp
+.pnp.js
 npm-debug.log*
 yarn-debug.log*
 yarn-error.log*
+
+# others
+.env*.local
+.vercel
+next-env.d.ts

.nvmrc

@@ -0,0 +1 @@
+22.14.0

.prettierrc

@@ -1,100 +1,85 @@
 {
-  "editor.inlineSuggest.enabled": true,
-  "workbench.productIconTheme": "fluent-icons",
-  "workbench.iconTheme": "vscode-icons",
-  "diffEditor.ignoreTrimWhitespace": false,
-  "editor.tabSize": 2,
-  "git.enableSmartCommit": true,
-  "editor.defaultFormatter": "esbenp.prettier-vscode",
+  "typescript.tsdk": "node_modules/typescript/lib",
+  "editor.defaultFormatter": "biomejs.biome",
+  "editor.formatOnSave": true,
+  "editor.formatOnPaste": true,
+  "emmet.showExpandedAbbreviation": "never",
   "editor.codeActionsOnSave": {
-    "source.addMissingImports": "explicit",
-    "source.organizeImports": "explicit",
-    "source.fixAll.eslint": "explicit"
+    "quickfix.biome": "explicit",
+    "source.organizeImports.biome": "explicit"
   },
-  "eslint.execArgv": [
-    "--max-old-space-size=8192",
-    "--max-semi-space-size=8192"
-  ],
-  "git.confirmSync": false,
-  "git.autofetch": true,
-  "explorer.confirmDelete": false,
-  "explorer.confirmDragAndDrop": false,
-  "javascript.updateImportsOnFileMove.enabled": "never",
-  "workbench.tree.renderIndentGuides": "always",
-  "workbench.colorCustomizations": {
-    "tree.indentGuidesStroke": "#05ef3c9c"
+  "[typescript]": {
+    "editor.defaultFormatter": "biomejs.biome"
+  },
+  "[json]": {
+    "editor.defaultFormatter": "biomejs.biome"
+  },
+  "[javascript]": {
+    "editor.defaultFormatter": "biomejs.biome"
+  },
+  "[jsonc]": {
+    "editor.defaultFormatter": "biomejs.biome"
+  },
+  "[typescriptreact]": {
+    "editor.defaultFormatter": "biomejs.biome"
   },
-  "solidity.compilerOptimization": 2000,
-  "solidity.compileUsingRemoteVersion": "v0.8.20+commit.a1b79de6",
+  "[solidity]": {
+    "editor.defaultFormatter": "NomicFoundation.hardhat-solidity"
+  },
+  "solidity.formatter": "forge",
+  "solidity.telemetry": false,
+  "editor.stickyScroll.enabled": true,
+  "editor.tabSize": 2,
   "errorLens.fontStyleItalic": true,
-  "editor.fontWeight": "normal",
-  "editor.minimap.enabled": false,
-  "redhat.telemetry.enabled": false,
-  "security.promptForLocalFileProtocolHandling": false,
-  "workbench.editor.enablePreview": false,
   "explorer.fileNesting.enabled": true,
   "explorer.fileNesting.patterns": {
-    "*.ts": "${capture}.js, ${capture}.typegen.ts, ${capture}.spec.ts",
+    "*.cts": "${capture}.typegen.ts",
     "*.js": "${capture}.js.map, ${capture}.min.js, ${capture}.d.ts",
     "*.jsx": "${capture}.js",
+    "*.mts": "${capture}.typegen.ts",
+    "*.ts": "${capture}.js, ${capture}.typegen.ts, ${capture}.spec.ts, ${capture}.test.ts",
     "*.tsx": "${capture}.ts, ${capture}.typegen.ts",
-    "tsconfig.json": "tsconfig.*.json",
     "package.json": "package-lock.json, yarn.lock, pnpm-lock.yaml, bun.lockb, bun.lock",
-    "*.mts": "${capture}.typegen.ts",
-    "*.cts": "${capture}.typegen.ts"
-  },
-  "typescript.tsserver.maxTsServerMemory": 16384,
-  "workbench.activityBar.orientation": "vertical",
-  "typescript.disableAutomaticTypeAcquisition": true,
-  "editor.formatOnSave": true,
-  "editor.cursorBlinking": "smooth",
-  "editor.cursorSmoothCaretAnimation": "on",
-  "editor.stickyScroll.enabled": true,
-  "githubPullRequests.pullBranch": "never",
-  "autoBarrel.ignoreFilePathContainingAnyOf": ".spec,.test,pulumi-templates/route,pulumi-templates/scc,.d.ts,module-definition,pulumi-resources/route,pulumi-resources/scc,pulumi-resources/velero",
-  "eslint.codeActionsOnSave.rules": null,
-  "[typescript]": {
-    "editor.defaultFormatter": "esbenp.prettier-vscode"
+    "tsconfig.json": "tsconfig.*.json"
   },
-  "[json]": {
-    "editor.defaultFormatter": "esbenp.prettier-vscode"
-  },
-  "[jsonc]": {
-    "editor.defaultFormatter": "esbenp.prettier-vscode"
+  "files.associations": {
+    "*.css": "tailwindcss"
   },
-  "javascript.preferences.importModuleSpecifier": "project-relative",
-  "nxConsole.showNodeVersionOnStartup": false,
-  "typescript.tsdk": "node_modules/typescript/lib",
-  "typescript.enablePromptUseWorkspaceTsdk": true,
-  "typescript.inlayHints.variableTypes.enabled": true,
-  "typescript.preferences.preferTypeOnlyAutoImports": true,
-  "typescript.updateImportsOnFileMove.enabled": "never",
-  "typescript.inlayHints.enumMemberValues.enabled": true,
+  "git.autofetch": true,
+  "git.autoStash": true,
+  "git.enableCommitSigning": true,
+  "git.enableSmartCommit": true,
+  "githubPullRequests.commentExpandState": "collapseAll",
+  "githubPullRequests.defaultMergeMethod": "squash",
+  "githubPullRequests.notifications": "pullRequests",
+  "githubPullRequests.quickDiff": true,
+  "sherlock.userId": "2e2829ed-26e5-4fb5-87e9-3d921da61e9f",
+  "trailing-spaces.trimOnSave": true,
   "typescript.inlayHints.functionLikeReturnTypes.enabled": true,
-  "typescript.inlayHints.parameterNames.enabled": "all",
   "typescript.inlayHints.parameterTypes.enabled": true,
   "typescript.inlayHints.propertyDeclarationTypes.enabled": true,
-  "editor.codeLens": true,
+  "typescript.inlayHints.variableTypes.enabled": true,
+  "typescript.suggest.completeFunctionCalls": true,
   "typescript.tsserver.experimental.enableProjectDiagnostics": true,
-  "trailing-spaces.trimOnSave": true,
-  "yaml.schemas": {},
-  "workbench.tree.enableStickyScroll": true,
-  "git.openRepositoryInParentFolders": "never",
-  "codesnap.realLineNumbers": true,
-  "codesnap.showWindowTitle": true,
-  "codesnap.shutterAction": "copy",
-  "codesnap.transparentBackground": true,
-  "codesnap.backgroundColor": "#282828",
-  "editor.wordWrap": "on",
-  "files.associations": {
-    "*.css": "tailwindcss"
+  "typescript.tsserver.maxTsServerMemory": 16384,
+  "typescript.tsserver.watchOptions": {
+    "fallbackPolling": "dynamicPriorityPolling",
+    "synchronousWatchDirectory": true,
+    "watchDirectory": "useFsEvents",
+    "watchFile": "useFsEventsOnParentDirectory"
   },
-  "editor.quickSuggestions": {
-    "strings": "on"
+  "workbench.editor.customLabels.patterns": {
+    "**/app/**/layout.tsx": "${dirname(1)}/${dirname} <layout>",
+    "**/app/**/page.tsx": "${dirname(1)}/${dirname} <page>",
+    "**/app/**/route.ts": "${dirname(1)}/${dirname} <route>",
+    "**/components/**/index.tsx": "${dirname(1)}/${dirname} <component>"
   },
-  "eslint.workingDirectories": [
-    {
-      "mode": "auto"
-    }
-  ]
+  "workbench.tree.enableStickyScroll": true,
+  "typescript.enablePromptUseWorkspaceTsdk": true,
+  "[dockerfile]": {
+    "editor.defaultFormatter": "ms-azuretools.vscode-docker"
+  },
+  "[mdx]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
+  }
 }