From 5d452f6bad7474adb353d2ffe8bf149c6de36714 Mon Sep 17 00:00:00 2001 From: Nahiyan Khan Date: Thu, 4 Jun 2026 23:00:20 -0400 Subject: [PATCH] Document Ghost beta status --- .changeset/beta-status-notice.md | 5 +++++ README.md | 11 +++++++++++ apps/docs/src/content/docs/getting-started.mdx | 13 +++++++++++++ packages/ghost/README.md | 11 +++++++++++ 4 files changed, 40 insertions(+) create mode 100644 .changeset/beta-status-notice.md diff --git a/.changeset/beta-status-notice.md b/.changeset/beta-status-notice.md new file mode 100644 index 0000000..e952368 --- /dev/null +++ b/.changeset/beta-status-notice.md @@ -0,0 +1,5 @@ +--- +"@anarchitecture/ghost": patch +--- + +Document that Ghost is pre-1.0 beta software and may ship breaking changes during active development. diff --git a/README.md b/README.md index 2427019..cfd233d 100644 --- a/README.md +++ b/README.md @@ -60,6 +60,17 @@ Advanced workflows can add nested fingerprint packages for product areas, custom comparison. Those features stay available, but the core loop is just `fingerprint/`, optional active checks, and Git review. +## Project Status: Beta + +Ghost is pre-1.0 and under active development. The CLI, fingerprint schema, +on-disk `.ghost/fingerprint/` package shape, and public JavaScript exports may +change in breaking ways before a stable 1.0 release. + +Breaking changes may ship in minor versions while Ghost is pre-1.0. Patch +versions are reserved for fixes that should not require migration. If you adopt +Ghost today, expect some churn, pin the version you depend on, and review +release notes before upgrading. + ## Install The public npm package is **`@anarchitecture/ghost`**. It installs one CLI: diff --git a/apps/docs/src/content/docs/getting-started.mdx b/apps/docs/src/content/docs/getting-started.mdx index 458f640..dc34afd 100644 --- a/apps/docs/src/content/docs/getting-started.mdx +++ b/apps/docs/src/content/docs/getting-started.mdx @@ -39,6 +39,19 @@ root-to-leaf for the file or diff being reviewed. + + +Ghost is pre-1.0 and under active development. The CLI, fingerprint schema, +on-disk `.ghost/fingerprint/` package shape, and public JavaScript exports may +change in breaking ways before a stable 1.0 release. + +Breaking changes may ship in minor versions while Ghost is pre-1.0. Patch +versions are reserved for fixes that should not require migration. If you adopt +Ghost today, expect some churn, pin the version you depend on, and review +release notes before upgrading. + + + ```bash diff --git a/packages/ghost/README.md b/packages/ghost/README.md index 53f1125..3ca25ad 100644 --- a/packages/ghost/README.md +++ b/packages/ghost/README.md @@ -6,6 +6,17 @@ Ghost initializes root `.ghost/fingerprint/` memory, checks diffs against deterministic gates, emits advisory review packets, compares packages, and records intentional drift. It ships one CLI: `ghost`. +## Project Status: Beta + +Ghost is pre-1.0 and under active development. The CLI, fingerprint schema, +on-disk `.ghost/fingerprint/` package shape, and public JavaScript exports may +change in breaking ways before a stable 1.0 release. + +Breaking changes may ship in minor versions while Ghost is pre-1.0. Patch +versions are reserved for fixes that should not require migration. If you adopt +Ghost today, expect some churn, pin the version you depend on, and review +release notes before upgrading. + ## Install ```bash