Skip to content

Fix README workspace shape diagram #459

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

Open
codeforester wants to merge 1 commit into
base: master
Choose a base branch
from
+7 −14
Open

Fix README workspace shape diagram #459

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
21 changes: 7 additions & 14 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1014,24 +1014,17 @@ for in a monorepo, without forcing unrelated codebases into a single repository.
The target shape looks roughly like this:

```text
work/
base/
README.md
cli/
bash/
python/
lib/
manifests/
project-a/
project-b/
infra/
work/ ← shared workspace root (`workspace.root`)
base/ ← Base repository (`BASE_HOME` for source installs)
project-a/ ← peer project with `base_manifest.yaml`
project-b/ ← peer project with `base_manifest.yaml`
infra/ ← another peer repo that can opt into Base
```

Projects should be able to opt into Base with minimal coupling. The exact
mechanism is still being designed, but the intent is clear:
Projects opt into Base with minimal coupling:

- Base discovers projects in the shared workspace
- projects expose a small contract to Base
- projects expose a small contract through `base_manifest.yaml`
- Base provides common orchestration on top

## Design Principles
Expand Down
Loading