Skip to content

docs: add npm publishing info and ci-entry details to contributing page #49

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
parse merged 1 commit into from
Mar 8, 2026
Merged

docs: add npm publishing info and ci-entry details to contributing page #49

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

16 changes: 12 additions & 4 deletions packages/web/src/content/docs/docs/contributing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`.