You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
> Note: The documentation site lives in the `codervisor/lean-spec-docs` repository and is mounted here as the `docs-site/`submodule. Run `git submodule update --init --recursive` after cloning if you plan to work on docs.
14
+
> Note: The documentation site lives in the `codervisor/lean-spec-docs` repository and is merged here as the `docs-site/`directory using git subtree. It's already included when you clone the repo - no additional steps needed.
15
15
16
16
## Development Setup
17
17
@@ -96,20 +96,32 @@ git push
96
96
- Automated sync in CI/CD
97
97
- Simpler release process
98
98
99
-
### Docs Site Submodule
99
+
### Docs Site Subtree
100
100
101
-
The docs are maintained in [codervisor/lean-spec-docs](https://github.com/codervisor/lean-spec-docs) and pulled in via the `docs-site/` git submodule. Typical workflow:
101
+
The docs are maintained in [codervisor/lean-spec-docs](https://github.com/codervisor/lean-spec-docs) and merged into this repo at `docs-site/`using git subtree. The docs are already included when you clone.
102
102
103
+
**Local development:**
103
104
```bash
104
-
git submodule update --init --recursive # first time or when the submodule is missing
105
105
cd docs-site
106
-
pnpm install # install docs dependencies once inside the submodule
107
-
pnpm start # develop docs locally
108
-
git commit -am "docs: ..."&& git push # push changes from inside the submodule
106
+
pnpm install # install docs dependencies
107
+
pnpm start # develop docs locally
108
+
```
109
+
110
+
**Pushing docs changes:**
111
+
```bash
112
+
# Make changes in docs-site/, then commit to this repo
113
+
git add docs-site
114
+
git commit -m "docs: your changes"
115
+
git push
109
116
110
-
cd ..
111
-
git add docs-site # stage updated submodule pointer in this repo
112
-
git commit -m "chore: bump docs-site"
117
+
# Push to the separate docs repo (maintainers only)
118
+
git subtree push --prefix=docs-site https://github.com/codervisor/lean-spec-docs.git main
119
+
```
120
+
121
+
**Pulling docs changes from upstream:**
122
+
```bash
123
+
# Pull latest from the separate docs repo
124
+
git subtree pull --prefix=docs-site https://github.com/codervisor/lean-spec-docs.git main --squash
113
125
```
114
126
115
127
### Monorepo with Turborepo
@@ -125,7 +137,7 @@ This project uses [Turborepo](https://turbo.build/) to manage the monorepo with
125
137
-`packages/mcp` - MCP server wrapper (published as `@leanspec/mcp`)
126
138
-`packages/ui` - Web UI bundle (published as `@leanspec/ui`)
127
139
-`packages/desktop` - Tauri desktop app (not published to npm)
0 commit comments