From f85417d7553dbf0d89370fe25a5185a48626db0e Mon Sep 17 00:00:00 2001 From: Anders Hassis Date: Sun, 8 Mar 2026 10:39:10 +0100 Subject: [PATCH] docs: add npm publishing info and ci-entry details to contributing page --- package-lock.json | 1 - .../web/src/content/docs/docs/contributing.md | 16 ++++++++++++---- 2 files changed, 12 insertions(+), 5 deletions(-) diff --git a/package-lock.json b/package-lock.json index 17f7968..3412fcb 100644 --- a/package-lock.json +++ b/package-lock.json @@ -6669,7 +6669,6 @@ "resolved": "https://registry.npmjs.org/marked/-/marked-15.0.12.tgz", "integrity": "sha512-8dD6FusOQSrpv9Z1rdNMdlSgQOIP880DHqnohobOmYLElGEqAL/JvxvuxZO16r4HtjTlfPRDC1hbvxC9dPN2nA==", "license": "MIT", - "peer": true, "bin": { "marked": "bin/marked.js" }, diff --git a/packages/web/src/content/docs/docs/contributing.md b/packages/web/src/content/docs/docs/contributing.md index 3878b10..2fba733 100644 --- a/packages/web/src/content/docs/docs/contributing.md +++ b/packages/web/src/content/docs/docs/contributing.md @@ -17,7 +17,15 @@ Erode is an npm workspace monorepo. The diagram below shows the package structur ## Packages -- **core**: Analysis engine with AI pipeline, providers, adapters, and platform integrations. -- **cli**: Interactive terminal interface. -- **web**: Documentation and landing page. -- **eslint-config**: Shared ESLint configuration for all packages. +| Package | npm | Description | +| ----------------- | ----------------- | ----------------------------------------------------------------------- | +| **core** | `@erode-app/core` | Analysis engine. Exports the `erode-ci` binary used by CI integrations. | +| **cli** | `@erode-app/cli` | Interactive terminal interface. Exports the `erode` binary. | +| **web** | private | Documentation and landing page. | +| **architecture** | private | LikeC4 architecture diagrams. | +| **eslint-config** | private | Shared ESLint configuration. | + +### CI entry point + +GitHub Actions, GitLab CI, and Bitbucket Pipelines all invoke `erode-ci` (core's `dist/ci-entry.js`). +The entrypoint scripts live at the repo root: `entrypoint.sh`, `entrypoint-gitlab.sh`, `entrypoint-bitbucket.sh`.