Draft for user docs for workspaces

These docs are not yet meant to be consumed by end users, for now they allow sharing the state of workspace support in terms of features that are relevant to users, and to gather feedback on the design. We can progressively update this doc as workspace support matures.

Author: konstin

docs/workspaces.md

@@ -0,0 +1,84 @@
+**Warning: this documentation applies to a future version of uv. Please refer to
+[README.md](../README.md) for documentation for the latest release.**
+
+Workspaces help you organize large codebases by splitting them into multiple packages with
+independent dependencies.
+
+When using the `uv pip` interface, workspace dependencies behave like automatic editable path
+dependencies. Using the `uv` interface, all your workspace packages are locked together. `uv run`
+installs only the current package (unless overridden with `--package`) and its workspace and
+non-workspace dependencies.
+
+## Configuration
+
+You can create a workspace by adding a `tool.uv.workspace` to a pyproject.toml that is the workspace
+root. This table contains `members` (mandatory) and `exclude` (optional), with lists of globs of
+directories:
+
+```toml
+[tool.uv.workspace]
+members = ["packages/*", "examples/*"]
+exclude = ["example/excluded_example"]
+```
+
+If you define `tool.uv.sources` in your workspace root, it applies to all packages, unless
+overridden in the `tool.uv.sources` of a specific project.
+
+## Common usage
+
+There a two main usage patterns: A root package and helpers, and the flat workspace.
+
+Root package and helpers: In this layout `albatross/pyproject.toml` has both a `project` section and
+a `tool.uv.workspace` section.
+
+```
+albatross
+├── packages
+│   ├── provider_a
+│   │   ├── pyproject.toml
+│   │   └── src
+│   │       └── provider_a
+│   │           ├── __init__.py
+│   │           └── foo.py
+│   └── provider_b
+│       ├── pyproject.toml
+│       └── src
+│           └── provider_b
+│               ├── __init__.py
+│               └── bar.py
+├── pyproject.toml
+├── README.md
+├── uv.lock
+└── src
+    └── albatross
+        └── main.py
+```
+
+Flat workspace: In this layout `albatross/pyproject.toml` has only `tool.uv.workspace` section, but
+no `project`.
+
+```
+albatross
+├── packages
+│   ├── albatross
+│   │   ├── pyproject.toml
+│   │   └── src
+│   │       └── albatross
+│   │           ├── __init__.py
+│   │           └── foo.py
+│   ├── provider_a
+│   │   ├── pyproject.toml
+│   │   └── src
+│   │       └── provider_a
+│   │           ├── __init__.py
+│   │           └── foo.py
+│   └── provider_b
+│       ├── pyproject.toml
+│       └── src
+│           └── provider_b
+│               ├── __init__.py
+│               └── bar.py
+├── pyproject.toml
+├── README.md
+└── uv.lock
+```