feat: docs sync

Author: stigi

.github/sync.yml

@@ -0,0 +1,3 @@
+magicbell/magicbell:
+  - source: docs-dist
+    dest: src/go/app/site/docs/mdx/03-libraries/magicbell-java-client

.github/workflows/publish-docs.yml

@@ -0,0 +1,24 @@
+name: Publish Docs
+
+on:
+  release:
+    types: [created]
+  workflow_dispatch:
+  
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code  
+        uses: actions/checkout@v4
+
+      - name: Build docs
+        run: yarn build:docs
+
+      - name: Push docs to remote repo
+        uses: BetaHuhn/repo-file-sync-action@v1
+        with:
+          GH_PAT: ${{ secrets.BELLA_ACTION_TOKEN }}
+          COMMIT_PREFIX: 'docs: '
+          GIT_USERNAME: 'MagicBella'
+          GIT_EMAIL: '${{ secrets.BELLA_EMAIL_ADDRESS }}'

.gitignore

@@ -1,3 +1,5 @@
 # Tooling
 node_modules/
-target
+target
+
+docs-dist

package.json

@@ -5,12 +5,15 @@
   "type": "module",
   "scripts": {
     "changeset": "./scripts/changeset-wrapper.sh",
-    "codegen": "tsx scripts/liblab-gen.ts"
+    "codegen": "tsx scripts/liblab-gen.ts",
+    "build:docs": "tsx scripts/liblab-docs.ts"
   },
   "devDependencies": {
     "@changesets/changelog-github": "^0.5.0",
     "@changesets/cli": "^2.27.10",
+    "@magicbell/codegen": "^0.3.0",
     "@types/node": "^22.10.2",
+    "glob": "^11.0.0",
     "replace-in-file": "^8.2.0",
     "tsx": "^4.19.2"
   }

scripts/liblab-docs.ts

@@ -0,0 +1,57 @@
+import fs from 'node:fs/promises';
+import path from 'node:path';
+
+import { exists, getDirs } from '@magicbell/codegen/fs';
+import * as md from '@magicbell/codegen/markdown';
+import * as glob from 'glob';
+
+function pascalToHyphenCase(str: string): string {
+  return str.replace(/([a-z])([A-Z])/g, '$1-$2').toLowerCase();
+}
+
+function rewriteHref(url: string) {
+  if (!url.endsWith('.md')) return url;
+  return url.replace(/^documentation\//, '').replace(/([^/]+)\.md$/, (_, fileName) => pascalToHyphenCase(fileName));
+}
+
+const root = process.cwd();
+const outdir = path.join(root, 'docs-dist');
+await fs.rm(outdir, { recursive: true, force: true });
+
+const pkg = JSON.parse(await fs.readFile('package.json', 'utf-8'));
+
+// process readme
+const [readme] = glob.sync('README.md', { cwd: root });
+const readmeAst = await md.read(readme);
+md.removeAllBeforeHeading(readmeAst, 'Setup & Configuration');
+md.reIndentHeadings(readmeAst, 1);
+md.mapLinks(readmeAst, rewriteHref);
+md.insertFrontMatter(readmeAst, { title: pkg.name });
+
+await md.write(readmeAst, path.join(outdir, 'index.mdx'));
+
+// process pages
+const docs = glob.sync('**/*.md', {
+  cwd: path.join(root, 'documentation'),
+});
+
+for (const file of docs) {
+  const ast = await md.read(path.join(root, 'documentation', file));
+
+  md.reIndentHeadings(ast, 1);
+  md.mapLinks(ast, rewriteHref);
+
+  const title = md.getTitle(ast);
+  md.insertFrontMatter(ast, { title });
+  md.removeFirstHeading(ast);
+
+  await md.write(ast, path.join(outdir, pascalToHyphenCase(file) + 'x'));
+}
+
+for (const dir of getDirs(docs)) {
+  const file = path.join(outdir, dir, 'index.mdx');
+  if (await exists(file)) continue;
+  const ast: md.Root = { type: 'root', children: [] };
+  md.insertFrontMatter(ast, { title: path.basename(dir) });
+  await md.write(ast, file);
+}