Skip to content

docs: ✍️ Scribe: Update project structure in README.md#944

Draft
fderuiter wants to merge 1 commit into
mainfrom
docs/scribe-update-readme-structure-935352066392667647
Draft

docs: ✍️ Scribe: Update project structure in README.md#944
fderuiter wants to merge 1 commit into
mainfrom
docs/scribe-update-readme-structure-935352066392667647

Conversation

@fderuiter
Copy link
Copy Markdown
Owner

💡 What: Updated the ASCII project structure tree in README.md to show the new packages/ monorepo layout (including core/, plugins-workflows/, and providers-airflow/) instead of the outdated imednet/ directory.
🎯 Why: The project recently migrated to a monorepo workspace structure. The README.md was still incorrectly pointing users to the imednet/ directory as the SDK package, which no longer exists at the root level.
🧠 Cognitive Impact: Prevents confusion and broken onboarding paths for new developers. By accurately mapping the project structure, developers can immediately understand where the core SDK lives vs. workflow plugins and Airflow providers, significantly reducing their "Time to Understand".
📖 Preview:

.
├── docs/       - Sphinx documentation
├── examples/   - Usage samples
├── packages/   - Workspace packages
│   ├── core/              - Main SDK package
│   ├── plugins-workflows/ - Workflow plugins package
│   └── providers-airflow/ - Airflow providers package
├── scripts/    - Helper scripts
└── tests/      - Unit and integration tests

PR created automatically by Jules for task 935352066392667647 started by @fderuiter

Updates the Project Structure ascii map in the README.md to accurately reflect the new monorepo layout under `packages/` (core, plugins-workflows, providers-airflow) rather than the outdated `imednet/` structure.

Co-authored-by: google-labs-jules[bot] <161369871+google-labs-jules[bot]@users.noreply.github.com>
@google-labs-jules
Copy link
Copy Markdown
Contributor

👋 Jules, reporting for duty! I'm here to lend a hand with this pull request.

When you start a review, I'll add a 👀 emoji to each comment to let you know I've read it. I'll focus on feedback directed at me and will do my best to stay out of conversations between you and other bots or reviewers to keep the noise down.

I'll push a commit with your requested changes shortly after. Please note there might be a delay between these steps, but rest assured I'm on the job!

For more direct control, you can switch me to Reactive Mode. When this mode is on, I will only act on comments where you specifically mention me with @jules. You can find this option in the Pull Request section of your global Jules UI settings. You can always switch back!

New to Jules? Learn more at jules.google/docs.


For security, I will only act on instructions from the user who triggered this task.

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