From 94bed0ba146bb5c048b5c8925365fb8dfa2f07ba Mon Sep 17 00:00:00 2001 From: Wayne Sutton Date: Sat, 10 Jan 2026 08:52:50 -0800 Subject: [PATCH] update: updated sync commands documentation --- README.md | 14 ++++++++++++++ content/pages/about.md | 2 ++ content/pages/docs-dashboard.md | 22 ++++++++++++---------- content/pages/docs.md | 2 ++ public/raw/about.md | 2 ++ public/raw/docs-dashboard.md | 22 ++++++++++++---------- public/raw/documentation.md | 2 ++ 7 files changed, 46 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index 675f132..a66506b 100644 --- a/README.md +++ b/README.md @@ -14,6 +14,8 @@ Write markdown locally, run `npm run sync` (dev) or `npm run sync:prod` (product **Sync commands:** +Sync command scripts are located in `scripts/` (sync-posts.ts, sync-discovery-files.ts). + **Development:** - `npm run sync` - Sync markdown content @@ -26,6 +28,11 @@ Write markdown locally, run `npm run sync` (dev) or `npm run sync:prod` (product - `npm run sync:discovery:prod` - Update discovery files - `npm run sync:all:prod` - Sync content + discovery files together +**Export dashboard content:** + +- `npm run export:db` - Export dashboard posts/pages to content folders (development) +- `npm run export:db:prod` - Export dashboard posts/pages (production) + **How versioning works:** Markdown files live in `content/blog/` and `content/pages/`. These are regular files in your git repo. Commit changes, review diffs, roll back like any codebase. The sync command pushes content to Convex. ```bash @@ -319,6 +326,8 @@ Both files are gitignored. Each developer creates their own. ### Sync Commands +Sync command scripts are located in `scripts/` (sync-posts.ts, sync-discovery-files.ts). + **Development:** - `npm run sync` - Sync markdown content to development Convex @@ -331,6 +340,11 @@ Both files are gitignored. Each developer creates their own. - `npm run sync:discovery:prod` - Update discovery files with production data - `npm run sync:all:prod` - Sync content + discovery files together +**Export dashboard content:** + +- `npm run export:db` - Export dashboard posts/pages to content folders (development) +- `npm run export:db:prod` - Export dashboard posts/pages (production) + **Development sync:** ```bash diff --git a/content/pages/about.md b/content/pages/about.md index 1a42731..10ba371 100644 --- a/content/pages/about.md +++ b/content/pages/about.md @@ -18,6 +18,8 @@ An open-source publishing framework built for AI agents and developers to ship w **Sync commands:** +Sync command scripts are located in `scripts/` (sync-posts.ts, sync-discovery-files.ts). + **Development:** - npm run sync - Sync markdown content diff --git a/content/pages/docs-dashboard.md b/content/pages/docs-dashboard.md index b45ca7f..331b1a6 100644 --- a/content/pages/docs-dashboard.md +++ b/content/pages/docs-dashboard.md @@ -348,30 +348,32 @@ This creates a file in `content/blog/` that requires syncing. ### Sync commands reference +Sync command scripts are located in `scripts/` (sync-posts.ts, sync-discovery-files.ts). + **Development:** -- `npm run sync` - Sync markdown content to development Convex -- `npm run sync:discovery` - Update discovery files (AGENTS.md, llms.txt) with development data -- `npm run sync:all` - Run both content sync and discovery sync (development) +- npm run sync - Sync markdown content to development Convex +- npm run sync:discovery - Update discovery files (AGENTS.md, llms.txt) with development data +- npm run sync:all - Run both content sync and discovery sync (development) **Production:** -- `npm run sync:prod` - Sync markdown content to production Convex -- `npm run sync:discovery:prod` - Update discovery files with production data -- `npm run sync:all:prod` - Run both content sync and discovery sync (production) +- npm run sync:prod - Sync markdown content to production Convex +- npm run sync:discovery:prod - Update discovery files with production data +- npm run sync:all:prod - Run both content sync and discovery sync (production) **Sync Server:** -- `npm run sync-server` - Start local HTTP server for executing sync commands from dashboard UI +- npm run sync-server - Start local HTTP server for executing sync commands from dashboard UI **Content Import:** -- `npm run import ` - Import external URL as markdown post (requires FIRECRAWL_API_KEY in .env.local) +- npm run import <url> - Import external URL as markdown post (requires FIRECRAWL_API_KEY in .env.local) **Database Export:** -- `npm run export:db` - Export dashboard posts/pages to content folders (development) -- `npm run export:db:prod` - Export dashboard posts/pages (production) +- npm run export:db - Export dashboard posts/pages to content folders (development) +- npm run export:db:prod - Export dashboard posts/pages (production) **Note:** The dashboard provides a UI for these commands. When the sync server is running (`npm run sync-server`), you can execute commands directly from the dashboard with real-time output. Otherwise, the dashboard shows commands in a modal for copying to your terminal. diff --git a/content/pages/docs.md b/content/pages/docs.md index 6260a93..64a6e44 100644 --- a/content/pages/docs.md +++ b/content/pages/docs.md @@ -23,6 +23,8 @@ Reference documentation for setting up, customizing, and deploying this markdown **Sync commands:** +Sync command scripts are located in `scripts/` (sync-posts.ts, sync-discovery-files.ts). + **Development:** - npm run sync - Sync markdown content diff --git a/public/raw/about.md b/public/raw/about.md index a6232d6..cc4279e 100644 --- a/public/raw/about.md +++ b/public/raw/about.md @@ -17,6 +17,8 @@ An open-source publishing framework built for AI agents and developers to ship w **Sync commands:** +Sync command scripts are located in `scripts/` (sync-posts.ts, sync-discovery-files.ts). + **Development:** - npm run sync - Sync markdown content diff --git a/public/raw/docs-dashboard.md b/public/raw/docs-dashboard.md index 2a1340f..e40da1a 100644 --- a/public/raw/docs-dashboard.md +++ b/public/raw/docs-dashboard.md @@ -340,30 +340,32 @@ This creates a file in `content/blog/` that requires syncing. ### Sync commands reference +Sync command scripts are located in `scripts/` (sync-posts.ts, sync-discovery-files.ts). + **Development:** -- `npm run sync` - Sync markdown content to development Convex -- `npm run sync:discovery` - Update discovery files (AGENTS.md, llms.txt) with development data -- `npm run sync:all` - Run both content sync and discovery sync (development) +- npm run sync - Sync markdown content to development Convex +- npm run sync:discovery - Update discovery files (AGENTS.md, llms.txt) with development data +- npm run sync:all - Run both content sync and discovery sync (development) **Production:** -- `npm run sync:prod` - Sync markdown content to production Convex -- `npm run sync:discovery:prod` - Update discovery files with production data -- `npm run sync:all:prod` - Run both content sync and discovery sync (production) +- npm run sync:prod - Sync markdown content to production Convex +- npm run sync:discovery:prod - Update discovery files with production data +- npm run sync:all:prod - Run both content sync and discovery sync (production) **Sync Server:** -- `npm run sync-server` - Start local HTTP server for executing sync commands from dashboard UI +- npm run sync-server - Start local HTTP server for executing sync commands from dashboard UI **Content Import:** -- `npm run import ` - Import external URL as markdown post (requires FIRECRAWL_API_KEY in .env.local) +- npm run import <url> - Import external URL as markdown post (requires FIRECRAWL_API_KEY in .env.local) **Database Export:** -- `npm run export:db` - Export dashboard posts/pages to content folders (development) -- `npm run export:db:prod` - Export dashboard posts/pages (production) +- npm run export:db - Export dashboard posts/pages to content folders (development) +- npm run export:db:prod - Export dashboard posts/pages (production) **Note:** The dashboard provides a UI for these commands. When the sync server is running (`npm run sync-server`), you can execute commands directly from the dashboard with real-time output. Otherwise, the dashboard shows commands in a modal for copying to your terminal. diff --git a/public/raw/documentation.md b/public/raw/documentation.md index cd948e6..b4f190d 100644 --- a/public/raw/documentation.md +++ b/public/raw/documentation.md @@ -13,6 +13,8 @@ Reference documentation for setting up, customizing, and deploying this markdown **Sync commands:** +Sync command scripts are located in `scripts/` (sync-posts.ts, sync-discovery-files.ts). + **Development:** - npm run sync - Sync markdown content