Repository navigation
docs(branding): align public-facing docs with the real stack for OSS launch - #96
Merged
Merged
Conversation
…launch The README and docs site still described the pre-migration architecture (AWS CDK, DynamoDB, Lambda, npm/web-ui paths). Anyone cloning the repo and following the quick start would have failed immediately. This aligns every public-facing surface with what the code actually does today: Pulumi, PostgreSQL/Prisma, pg-boss workers, and the Bun + Nx workspace. README - Rewrite against the real stack; add badges, a mermaid architecture diagram, and a comparison vs Cloud Custodian / Komiser / AWS Instance Scheduler - Move development detail into CONTRIBUTING; verify every doc link resolves - Rename README.MD -> README.md (lowercase is the convention) Docs site - installation.mdx: CDK/DynamoDB -> local Bun + Docker Postgres, Pulumi deploy, env-var table sourced from .env.example - faq.mdx: replace DynamoDB/CDK/Lambda answers; correct the cost estimate - Add /docs/architecture (How It Works) and /docs/security (Security Model) Branding - Standardise on "Nucleus Ops" (repo slug nucleus-cloud-ops is unchanged) - Fix model name word order: "Claude 4.6 Sonnet" -> "Claude Sonnet 4.6" (the model itself is correct; only the ordering was wrong). CLAUDE.md and techstack.md were the genuinely stale ones, still citing 4.5. - Landing page: point OSS visitors at the install guide instead of /login, replace the three-tier pricing grid with a single MIT panel, attribute the stats to the maintainer's deployment, drop the unowned nucleus-ops.io domain Hygiene - SECURITY.md: replace template boilerplate with a real policy + security model - LICENSE: copyright holder is a person, not a project name - CONTRIBUTING.md: add dev setup and the conventions that come up in review - Mark docs/schema-design.md historical (it documents the removed DynamoDB design) - Add a CI workflow. Typecheck and build are blocking and verified green; lint and test are continue-on-error because of pre-existing failures (~99 files with no-explicit-any, plus mock-harness test failures), with a comment noting when to make them required. No application logic changes. Verified: bun run typecheck and bun run build both pass, and /docs/architecture and /docs/security prerender. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why
The README and docs site still described the pre-migration architecture — AWS CDK, DynamoDB, Lambda,
npm install,web-ui/paths. All three were removed long ago in favour of Pulumi, PostgreSQL/Prisma, and pg-boss workers in a Bun + Nx workspace.The practical consequence: anyone cloning the repo and following the quick start would have failed on the first command. Ahead of talking about this publicly as an open-source project, this aligns every public-facing surface with what the code actually does today.
No application logic changes — docs, marketing copy, and repo hygiene only.
What changed
README (
README.MD→README.md)CONTRIBUTING.md; all 13 doc links verified to resolvegit mv, since macOS is case-insensitive)Docs site
installation.mdx— CDK/DynamoDB replaced with local Bun + Docker Postgres and the Pulumi two-stack deploy; env-var table sourced from.env.examplefaq.mdx— replaced the DynamoDB/CDK/Lambda answers; corrected the cost estimate to reflect RDS + two Fargate services/docs/architecture(How It Works) and/docs/security(Security Model) — the two pages self-hosters need mostBranding
nucleus-cloud-opsis unchanged — it's good for search)Claude 4.6 Sonnet→Claude Sonnet 4.6. To be clear, the model itself was correct (anthropic.claude-sonnet-4-6); only the ordering was wrong.CLAUDE.mdandtechstack.mdwere the genuinely stale ones, still citing 4.5./loginwall they can't pass; the three-tier pricing grid (Cloud Hosted / Enterprise / SSO) is replaced with a single MIT panel, since an "Enterprise — Custom" column under an MIT banner reads as bait-and-switch on an open-source launch; stats are attributed to the maintainer's production deployment rather than implied as universal; removed the unownednucleus-ops.iodomain from the mock browser chromeHygiene
SECURITY.md— template boilerplate replaced with a real policy and security modelLICENSE— copyright holder is now a person, not a project nameCONTRIBUTING.md— added dev setup and the conventions that actually come up in reviewdocs/schema-design.mdmarked historical (it documents the removed DynamoDB design)ARCHITECTURE.md/AI_OPS_ARCHITECTURE.mdand removed the obsoletelambda/section fromtechstack.mdCI workflow — please read before merging
This adds
.github/workflows/ci.yml, but only typecheck and build are blocking. Lint and test run withcontinue-on-errorbecause of pre-existing failures onmaster-v1, not anything introduced here:web-uihas ~99 files with@typescript-eslint/no-explicit-anyerrorsweb-uihas no typecheck target at all (pertechstack.md, due to pre-existingtscerrors — so the typecheck job currently coversworkersonly)Each is commented in the workflow with the condition for making it required. I also deliberately did not add a CI badge to the README — the workflow hasn't run on GitHub yet, and a red badge is worse than no badge. Worth adding once you confirm it's green.
Verification
/docs/architectureand/docs/securityconfirmed present in the prerender manifest; the rebuilt marketing HTML contains the new hero copy and zero occurrences ofnucleus-ops.io.Still outstanding (needs you, not code)
.github/FUNDING.ymlif you want one (I don't know your sponsor handle)🤖 Generated with Claude Code