Skip to content

Commit 5ff5941

Browse files
committed
Feedback from @cscheid
1 parent 421f37b commit 5ff5941

File tree

1 file changed

+18
-2
lines changed

1 file changed

+18
-2
lines changed

claude.md

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,11 @@ Quarto is an open-source scientific and technical publishing system built on [Pa
1313

1414
## Repository Structure
1515

16-
The repository is organized as a monorepo using Yarn workspaces:
16+
The repository is organized as a monorepo using Yarn workspaces and Turborepo for build orchestration:
1717

1818
- `apps/`: Contains standalone applications
1919
- `vscode/`: VS Code extension for Quarto
20-
- `writer/`: Web-based Quarto editor
20+
- `writer/`: Experimental web-based Quarto editor (not in production, ignore this for now)
2121
- `lsp/`: Language Server Protocol implementation
2222
- `panmirror/`: WYSIWYG editor component
2323
- `packages/`: Contains shared libraries
@@ -26,10 +26,26 @@ The repository is organized as a monorepo using Yarn workspaces:
2626
- `quarto-core/`: Quarto-specific core functionality
2727
- Other utility packages
2828

29+
## Build System
30+
31+
Quarto uses [turborepo](https://turbo.build/) to manage the monorepo build process:
32+
33+
- `turbo.json`: Defines the pipeline configuration for common tasks
34+
- Common commands:
35+
- `yarn build`: Builds all packages and applications
36+
- `yarn dev-writer`: Runs the writer app in development mode
37+
- `yarn dev-vscode`: Runs the VS Code extension in development mode
38+
- `yarn lint`: Runs linters across all workspaces
39+
- `yarn build-vscode`: Builds only the VS Code extension and its dependencies
40+
41+
The turborepo pipeline helps optimize build times by caching build artifacts and respecting the dependency graph between packages.
42+
2943

3044
## Additional Resources
3145

3246
- [Quarto Website](https://quarto.org)
3347
- [Extension on Microsoft marketplace](https://marketplace.visualstudio.com/items?itemName=quarto.quarto)
3448
- [Extension on Open VSX Registry](https://open-vsx.org/extension/quarto/quarto)
3549
- [Quarto GitHub Organization](https://github.com/quarto-dev)
50+
51+
# Instructions

0 commit comments

Comments
 (0)