docs: update READMEs and guides with latest build process#673
Merged
trunk-io[bot] merged 1 commit intomainfrom Mar 14, 2026
Merged
docs: update READMEs and guides with latest build process#673trunk-io[bot] merged 1 commit intomainfrom
trunk-io[bot] merged 1 commit intomainfrom
Conversation
- Remove Bit references from main README.adoc and CONTRIBUTING.adoc - Update tech stack to reflect Nx, Vitest, and current tooling - Add comprehensive build and development instructions - Update eventiva/README.md with Nx workspace details - Update packages/core/README.md with build/test/lint commands - Update .devcontainer/README.md with build instructions - Update CLUSTER_SETUP.md to use pnpm nx commands consistently Co-authored-by: punk.gift9475 <punk.gift9475@alias.org.uk>
|
😎 Merged directly without going through the merge queue, as the queue was empty and the PR was up to date with the target branch - details. |
Contributor
📝 WalkthroughSummary by CodeRabbit
WalkthroughThis pull request updates documentation files across the monorepo to reflect a shift from Bit.cloud-centric workflows to Nx-based automation. Command examples transition from Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
✨ Simplify code
📝 Coding Plan
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
🧹 Nitpick comments (1)
eventiva/README.md (1)
20-74: Consider consolidating duplicated build/task examples.
BuildingandRunning Taskscurrently repeat several commands. A single canonical command table would reduce doc drift over time.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@eventiva/README.md` around lines 20 - 74, Consolidate the duplicated command lists under the "Building" and "Running Tasks" headings by creating a single canonical "Common Commands" section (or renaming one of the existing headings) that lists each nx/pnpm command once (e.g., pnpm nx run-many -t build, lint, typecheck, test and pnpm nx run <project-name>:<target>), keep the package-specific examples (like pnpm nx build core and pnpm nx run core:build/test/lint) as a short "Examples" subsection, and remove the repeated blocks so the README only documents each command once; update headings "Building" and "Running Tasks" to reference the new canonical section and ensure examples still demonstrate both global run-many and per-project usage.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@eventiva/README.md`:
- Around line 20-74: Consolidate the duplicated command lists under the
"Building" and "Running Tasks" headings by creating a single canonical "Common
Commands" section (or renaming one of the existing headings) that lists each
nx/pnpm command once (e.g., pnpm nx run-many -t build, lint, typecheck, test and
pnpm nx run <project-name>:<target>), keep the package-specific examples (like
pnpm nx build core and pnpm nx run core:build/test/lint) as a short "Examples"
subsection, and remove the repeated blocks so the README only documents each
command once; update headings "Building" and "Running Tasks" to reference the
new canonical section and ensure examples still demonstrate both global run-many
and per-project usage.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: dac07b4a-cfa9-4d91-ab63-a6cb4866be02
📒 Files selected for processing (6)
.devcontainer/CLUSTER_SETUP.md.devcontainer/README.mdCONTRIBUTING.adocREADME.adoceventiva/README.mdpackages/core/README.md
📜 Review details
🧰 Additional context used
🧠 Learnings (18)
📓 Common learnings
Learnt from: CR
Repo: Eventiva/Eventiva PR: 0
File: .cursor/rules/nx-guidance.mdc:0-0
Timestamp: 2026-03-09T23:29:08.149Z
Learning: Use `pnpm nx show projects --affected --json` to identify affected projects, and refer to the documentation for `nx affected` base/head configuration
Learnt from: CR
Repo: Eventiva/Eventiva PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-03-09T23:29:22.907Z
Learning: Prefix nx commands with the workspace's package manager (e.g., `pnpm nx build`, `npm exec nx test`) - avoids using globally installed CLI
Learnt from: CR
Repo: Eventiva/Eventiva PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-03-09T23:29:22.907Z
Learning: For Nx plugin best practices, check `node_modules/nx/<plugin>/PLUGIN.md`. Not all plugins have this file - proceed without it if unavailable
Learnt from: CR
Repo: Eventiva/Eventiva PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-03-09T23:29:22.907Z
Learning: When running tasks (for example build, lint, test, e2e, etc.), always prefer running the task through `nx` (i.e. `nx run`, `nx run-many`, `nx affected`) instead of using the underlying tooling directly
Learnt from: CR
Repo: Eventiva/Eventiva PR: 0
File: .cursor/rules/monitor-ci.md:0-0
Timestamp: 2026-03-09T23:28:57.420Z
Learning: Applies to {pnpm-lock.yaml,yarn.lock} : Use pnpm nx for package manager detection with pnpm-lock.yaml, yarn nx with yarn.lock, otherwise npx nx for running verifiable tasks
Learnt from: CR
Repo: Eventiva/Eventiva PR: 0
File: .cursor/rules/nx-guidance.mdc:0-0
Timestamp: 2026-03-09T23:29:08.149Z
Learning: Prefer using `nx run`, `nx run-many`, or `nx affected` commands instead of running the underlying tool directly
Learnt from: CR
Repo: Eventiva/Eventiva PR: 0
File: .cursor/rules/nx-guidance.mdc:0-0
Timestamp: 2026-03-09T23:29:08.149Z
Learning: In CI pipelines, run `nx run-many -t lint build typecheck` to execute linting, building, and type checking across projects
Learnt from: CR
Repo: Eventiva/Eventiva PR: 0
File: .cursor/rules/nx-guidance.mdc:0-0
Timestamp: 2026-03-09T23:29:08.149Z
Learning: Run single Nx tasks using `pnpm nx run <project>:<target>`
Learnt from: CR
Repo: Eventiva/Eventiva PR: 0
File: .cursor/rules/nx-guidance.mdc:0-0
Timestamp: 2026-03-09T23:29:08.149Z
Learning: In CI workflows, use `nx affected` to run tasks only on projects that have been changed, rather than all projects
Learnt from: CR
Repo: Eventiva/Eventiva PR: 0
File: .cursor/rules/nx-guidance.mdc:0-0
Timestamp: 2026-03-09T23:29:08.149Z
Learning: Run affected Nx tasks using `pnpm nx affected -t <target> [--base=main]`
📚 Learning: 2026-03-09T23:29:22.907Z
Learnt from: CR
Repo: Eventiva/Eventiva PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-03-09T23:29:22.907Z
Learning: Prefix nx commands with the workspace's package manager (e.g., `pnpm nx build`, `npm exec nx test`) - avoids using globally installed CLI
Applied to files:
.devcontainer/CLUSTER_SETUP.md.devcontainer/README.mdeventiva/README.md
📚 Learning: 2026-03-09T23:29:08.149Z
Learnt from: CR
Repo: Eventiva/Eventiva PR: 0
File: .cursor/rules/nx-guidance.mdc:0-0
Timestamp: 2026-03-09T23:29:08.149Z
Learning: Prefer using `nx run`, `nx run-many`, or `nx affected` commands instead of running the underlying tool directly
Applied to files:
.devcontainer/CLUSTER_SETUP.md
📚 Learning: 2026-03-09T23:29:22.907Z
Learnt from: CR
Repo: Eventiva/Eventiva PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-03-09T23:29:22.907Z
Learning: When running tasks (for example build, lint, test, e2e, etc.), always prefer running the task through `nx` (i.e. `nx run`, `nx run-many`, `nx affected`) instead of using the underlying tooling directly
Applied to files:
.devcontainer/CLUSTER_SETUP.md.devcontainer/README.mdeventiva/README.md
📚 Learning: 2026-03-09T23:28:57.420Z
Learnt from: CR
Repo: Eventiva/Eventiva PR: 0
File: .cursor/rules/monitor-ci.md:0-0
Timestamp: 2026-03-09T23:28:57.420Z
Learning: Applies to {pnpm-lock.yaml,yarn.lock} : Use pnpm nx for package manager detection with pnpm-lock.yaml, yarn nx with yarn.lock, otherwise npx nx for running verifiable tasks
Applied to files:
.devcontainer/CLUSTER_SETUP.md.devcontainer/README.mdeventiva/README.md
📚 Learning: 2026-03-09T23:29:08.149Z
Learnt from: CR
Repo: Eventiva/Eventiva PR: 0
File: .cursor/rules/nx-guidance.mdc:0-0
Timestamp: 2026-03-09T23:29:08.149Z
Learning: Use `pnpm nx show projects --affected --json` to identify affected projects, and refer to the documentation for `nx affected` base/head configuration
Applied to files:
.devcontainer/CLUSTER_SETUP.md.devcontainer/README.mdeventiva/README.md
📚 Learning: 2026-03-09T23:29:08.149Z
Learnt from: CR
Repo: Eventiva/Eventiva PR: 0
File: .cursor/rules/nx-guidance.mdc:0-0
Timestamp: 2026-03-09T23:29:08.149Z
Learning: Run single Nx tasks using `pnpm nx run <project>:<target>`
Applied to files:
.devcontainer/CLUSTER_SETUP.md.devcontainer/README.md
📚 Learning: 2026-03-09T23:29:08.149Z
Learnt from: CR
Repo: Eventiva/Eventiva PR: 0
File: .cursor/rules/nx-guidance.mdc:0-0
Timestamp: 2026-03-09T23:29:08.149Z
Learning: In CI pipelines, run `nx run-many -t lint build typecheck` to execute linting, building, and type checking across projects
Applied to files:
.devcontainer/CLUSTER_SETUP.md.devcontainer/README.mdeventiva/README.md
📚 Learning: 2026-03-09T23:29:08.149Z
Learnt from: CR
Repo: Eventiva/Eventiva PR: 0
File: .cursor/rules/nx-guidance.mdc:0-0
Timestamp: 2026-03-09T23:29:08.149Z
Learning: Use `pnpm nx g <generator> --help` to view available options, then run `pnpm nx g <generator> ... --no-interactive` for scaffolding new apps, libs, or project structures
Applied to files:
.devcontainer/CLUSTER_SETUP.md.devcontainer/README.mdeventiva/README.md
📚 Learning: 2026-03-09T23:29:08.149Z
Learnt from: CR
Repo: Eventiva/Eventiva PR: 0
File: .cursor/rules/nx-guidance.mdc:0-0
Timestamp: 2026-03-09T23:29:08.149Z
Learning: Run affected Nx tasks using `pnpm nx affected -t <target> [--base=main]`
Applied to files:
.devcontainer/CLUSTER_SETUP.md
📚 Learning: 2026-03-09T23:29:08.149Z
Learnt from: CR
Repo: Eventiva/Eventiva PR: 0
File: .cursor/rules/nx-guidance.mdc:0-0
Timestamp: 2026-03-09T23:29:08.149Z
Learning: Run multiple Nx tasks using `pnpm nx run-many -t <target> [-p project1,project2] [--exclude=...]`
Applied to files:
.devcontainer/CLUSTER_SETUP.md
📚 Learning: 2026-03-09T23:29:08.149Z
Learnt from: CR
Repo: Eventiva/Eventiva PR: 0
File: .cursor/rules/nx-guidance.mdc:0-0
Timestamp: 2026-03-09T23:29:08.149Z
Learning: Use `--skipNxCache`, `--verbose`, and `--nxBail` flags with Nx commands when needed for troubleshooting or specific requirements
Applied to files:
.devcontainer/CLUSTER_SETUP.md
📚 Learning: 2026-03-09T23:28:42.799Z
Learnt from: CR
Repo: Eventiva/Eventiva PR: 0
File: .cursor/rules/learnings.mdc:0-0
Timestamp: 2026-03-09T23:28:42.799Z
Learning: For CI, DevContainer, and Bit removal decisions, refer to `docs/learnings/ci-and-devcontainer.md`
Applied to files:
.devcontainer/README.mdREADME.adocCONTRIBUTING.adoc
📚 Learning: 2026-03-09T23:29:22.907Z
Learnt from: CR
Repo: Eventiva/Eventiva PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-03-09T23:29:22.907Z
Learning: For Nx plugin best practices, check `node_modules/nx/<plugin>/PLUGIN.md`. Not all plugins have this file - proceed without it if unavailable
Applied to files:
.devcontainer/README.mdeventiva/README.md
📚 Learning: 2026-03-09T23:29:08.149Z
Learnt from: CR
Repo: Eventiva/Eventiva PR: 0
File: .cursor/rules/nx-guidance.mdc:0-0
Timestamp: 2026-03-09T23:29:08.149Z
Learning: List installed Nx plugins using `pnpm nx list`, and add new plugins using `pnpm nx add <plugin>`
Applied to files:
.devcontainer/README.md
📚 Learning: 2026-03-09T23:29:22.907Z
Learnt from: CR
Repo: Eventiva/Eventiva PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-03-09T23:29:22.907Z
Learning: For navigating/exploring the workspace, invoke the `nx-workspace` skill first - it has patterns for querying projects, targets, and dependencies
Applied to files:
eventiva/README.md
📚 Learning: 2026-03-09T23:29:08.149Z
Learnt from: CR
Repo: Eventiva/Eventiva PR: 0
File: .cursor/rules/nx-guidance.mdc:0-0
Timestamp: 2026-03-09T23:29:08.149Z
Learning: View project configuration using `pnpm nx show project <name> --json` instead of reading project.json directly for full config information
Applied to files:
eventiva/README.md
📚 Learning: 2026-03-09T23:29:22.907Z
Learnt from: CR
Repo: Eventiva/Eventiva PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-03-09T23:29:22.907Z
Learning: For scaffolding tasks (creating apps, libs, project structure, setup), ALWAYS invoke the `nx-generate` skill FIRST before exploring or calling MCP tools
Applied to files:
eventiva/README.md
🪛 LanguageTool
eventiva/README.md
[misspelling] ~5-~5: Use “a” instead of ‘an’ if the following word doesn’t start with a vowel sound, e.g. ‘a sentence’, ‘a university’.
Context: ...ning and Production logistics, built as an Nx monorepo. ## Gett...
(EN_A_VS_AN)
🔇 Additional comments (6)
.devcontainer/CLUSTER_SETUP.md (1)
42-42: Good command normalisation topnpm nx.These updates make the run/migrate examples consistent and reduce the chance of using a global Nx binary by mistake.
Based on learnings: Prefix nx commands with the workspace's package manager (e.g.,
pnpm nx build) and prefernx run/nx run-many/nx affected.Also applies to: 54-54, 66-66, 74-74, 117-117, 155-155
.devcontainer/README.md (1)
29-60: Clear and practical devcontainer task guide.The added setup/build/task sections are actionable and aligned with the repo’s Nx workflow.
Based on learnings: When running tasks, prefer Nx commands and prefix Nx with the workspace package manager.
packages/core/README.md (1)
1-53: Solid package-level command documentation.The explicit
corecommands plus workspace-wide alternatives are clear and easy to follow.eventiva/README.md (1)
7-177: Great Nx-first onboarding rewrite.The new flow (prereqs → install → build/tasks → graph → quality/release) is much clearer for new contributors.
Based on learnings: Prefer running tasks through Nx and use package-manager-prefixed Nx commands.
CONTRIBUTING.adoc (1)
151-151: Process update is aligned with the Nx monorepo workflow.The review pipeline now clearly reflects build/lint/typecheck/test validation through Nx.
Also applies to: 160-163
README.adoc (1)
81-175: Excellent contributor setup and Nx command coverage.The prerequisites and step-by-step local workflow are clear, and the command list is consistent with the repo’s Nx conventions.
Based on learnings: Run tasks through Nx and prefix Nx commands with the workspace package manager.
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
2 participants
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.
Summary
This PR updates all README files and guides to reflect the current build process, removing outdated Bit references and adding comprehensive instructions for the Nx-based monorepo setup.
Changes
Main Documentation
Package Documentation
DevContainer Documentation
pnpm nxconsistentlyKey Updates
pnpm nxprefixTesting