Skip to content

docs(readme): Update dependency graph to reflect current package structure#243

Open
gidich wants to merge 1 commit into
mainfrom
update-dependency-graph-readme
Open

docs(readme): Update dependency graph to reflect current package structure#243
gidich wants to merge 1 commit into
mainfrom
update-dependency-graph-readme

Conversation

@gidich
Copy link
Copy Markdown
Member

@gidich gidich commented May 7, 2026

Updated the Dependency Graph section in readme.md:

  • Added missing/important packages: @ocom/graphql-handler, @ocom/service-apollo-server, @apps/ui-staff, @cellix/graphql-core, @cellix/ui-core
  • Improved the explanatory note (high-level view, omitted UI routes & verification packages for clarity)
  • Better organized Mermaid comments and dependencies based on actual package.json wiring (e.g. what @apps/api depends on)
  • Kept the clean two-subgraph DDD layout with ELK layout

This brings the diagram in sync with the current monorepo structure under packages/ocom/*, packages/cellix/*, apps/*, etc.

Ready for review & merge after CI passes.

Summary by Sourcery

Documentation:

  • Refresh the architectural dependency graph in the README to include new core packages, services, and UIs and clarify its high-level scope.

…kage structure (added graphql-handler, service-apollo-server, ui-staff, better notes)
@gidich gidich requested a review from a team May 7, 2026 06:30
@sourcery-ai
Copy link
Copy Markdown
Contributor

sourcery-ai Bot commented May 7, 2026

Reviewer's Guide

Updates the README’s dependency graph section to accurately reflect the current monorepo architecture, adding missing packages, refining the explanatory note, and reorganizing Mermaid nodes/edges and comments to match real package.json wiring, along with a minor BASE_URL line duplication and recipe history whitespace cleanup.

File-Level Changes

Change Details Files
Refresh the high-level dependency graph documentation to match current CellixJS/OwnerCommunity monorepo structure.
  • Add an explanatory note clarifying the scope and intent of the dependency graph and what packages are omitted for clarity.
  • Expand the Mermaid diagram with newly introduced or previously omitted packages in the ocom and cellix subgraphs.
  • Reorganize and rename Mermaid comments to emphasize DDD layering, foundational seedworks, and app composition.
  • Adjust graph edges to reflect actual dependencies between OCom services, Cellix seedwork, and apps based on package wiring, including new links for GraphQL handler and Apollo server services.
  • Mark local dev mocks and UI apps as standalone nodes without edges to reduce clutter.
readme.md
Minor README text and formatting tweaks around auth BASE_URL description and recipe history.
  • Duplicate the BASE_URL example sentence about including port 1355, resulting in a repeated clause.
  • Remove a few blank lines in the recipe history/npm init section to tighten formatting.
readme.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link
Copy Markdown
Contributor

@sourcery-ai sourcery-ai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey - I've left some high level feedback:

  • The BASE_URL bullet now repeats the 'When running on port 1355 include the explicit port: …' sentence twice; consider removing the duplicate to keep the description concise.
  • The dependency graph note hardcodes 'updated May 2026'; consider removing or generalizing this date so the documentation doesn’t appear stale as the diagram evolves.
Prompt for AI Agents
Please address the comments from this code review:

## Overall Comments
- The BASE_URL bullet now repeats the 'When running on port 1355 include the explicit port: …' sentence twice; consider removing the duplicate to keep the description concise.
- The dependency graph note hardcodes 'updated May 2026'; consider removing or generalizing this date so the documentation doesn’t appear stale as the diagram evolves.

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant