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
Copy file name to clipboardExpand all lines: README.md
+12-2Lines changed: 12 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -49,7 +49,7 @@ pnpm install
49
49
pnpm dev
50
50
```
51
51
52
-
Once the Hub is open, use the `Workspace memory` switch in the header to open the dedicated MemPalace page directly. That page now covers service state, target selection, in-app memory search, and safe wrapper actions.
52
+
Once the Hub is open, use the `Workspace memory` switch in the header to open the dedicated MemPalace page directly. That page now covers service state, target selection, in-app memory search, target-scoped graph builds, and safe wrapper actions.
53
53
The dashboard also exposes installable abilities and core services through the Workspace Capabilities panel, and supports a persisted `split` versus `discovery-first` repo layout.
54
54
55
55
If you want the fuller workspace path after that:
@@ -61,6 +61,7 @@ If you want the fuller workspace path after that:
61
61
## How To Contribute
62
62
63
63
- Start with [.github/CONTRIBUTING.md](.github/CONTRIBUTING.md).
64
+
- Use [docs/14-git-and-github-workflow.md](docs/14-git-and-github-workflow.md) for the default issue, discussion, branch, and PR path when a repo does not already document its own collaboration flow.
64
65
- Browse current [`help wanted`](https://github.com/RichardGeorgeDavis/Codex-Workspace/issues?q=is%3Aissue%20state%3Aopen%20label%3A%22help%20wanted%22) and [`good first issue`](https://github.com/RichardGeorgeDavis/Codex-Workspace/issues?q=is%3Aissue%20state%3Aopen%20label%3A%22good%20first%20issue%22) tickets.
65
66
- If the queue is thin, use [docs/13-contributor-roadmap.md](docs/13-contributor-roadmap.md) for the current contribution map and ready-to-open starter issue briefs.
66
67
- Use [GitHub Discussions Q&A](https://github.com/RichardGeorgeDavis/Codex-Workspace/discussions/categories/q-a) for setup or usage questions.
Copy file name to clipboardExpand all lines: docs/08-first-run-and-updates.md
+89-13Lines changed: 89 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -20,7 +20,28 @@ So if we want a predictable onboarding path, we need to provide it in tracked do
20
20
21
21
MemPalace is now integrated as the first core workspace memory service. The current bootstrap and doctor scripts can prepare and verify that service for the active workspace user.
22
22
23
-
## First-run questions
23
+
## Fastest way to try it
24
+
25
+
If you want the most concrete path first, start with Workspace Hub rather than reading the whole docs tree up front.
26
+
27
+
Run:
28
+
29
+
```bash
30
+
cd repos/workspace-hub
31
+
pnpm install
32
+
pnpm dev
33
+
```
34
+
35
+
Then, once the app is open:
36
+
37
+
1. open `Workspace memory` from the header
38
+
2. confirm service state and target context
39
+
3. run a retrieval search from the in-app search form
40
+
4. build a target-scoped graph for `Workspace docs` or a selected repo if you want the graph view
41
+
42
+
If that trial path is enough, stop there and keep the rest of this doc as optional setup and maintenance guidance.
43
+
44
+
## Optional first-run questions
24
45
25
46
Answer these in order:
26
47
@@ -85,7 +106,7 @@ pnpm install
85
106
pnpm dev
86
107
```
87
108
88
-
Once the Hub is open, use the `Workspace memory` switch in the header to open the dedicated MemPalace page. That page is the workspace-level view for memory state, target selection, and safe wrapper commands.
109
+
Once the Hub is open, use the `Workspace memory` switch in the header to open the dedicated MemPalace page. That page is the workspace-level view for memory state, target selection, in-app retrieval search, target-scoped graph builds, and safe wrapper commands.
89
110
90
111
### Mixed Stack
91
112
@@ -131,7 +152,8 @@ Current policy:
131
152
- keep `.agents/skills/` only when repo-local compatibility mirroring helps
132
153
- install upstream skills selectively
133
154
- keep secrets and machine-specific MCP config local-only
134
-
- default MCP examples to `read-only` capability tiers and opt into `mutating` only when required
155
+
- keep the official MCP v1 server set small: `openaiDeveloperDocs`, `context7`, `playwright`, `chrome-devtools`, and `github`
156
+
- treat `default-full` as the convenience default and `safe-readonly` as the downgrade path
135
157
- keep third-party orchestration local-only unless it proves itself
136
158
- if you trial `oh-my-codex`, treat it as an optional external layer or dedicated fork, not as a normal workspace dependency
137
159
@@ -210,16 +232,33 @@ When a reviewed upstream becomes part of how the whole workspace works, promote
210
232
211
233
## Recommended first run
212
234
213
-
### 1. Read the docs
235
+
### 1. Try Workspace Hub first
236
+
237
+
Run:
214
238
215
-
Start with:
239
+
```bash
240
+
cd repos/workspace-hub
241
+
pnpm install
242
+
pnpm dev
243
+
```
244
+
245
+
Then use the app in this order:
246
+
247
+
1.`Workspace memory`
248
+
2. target selection
249
+
3. in-app retrieval search
250
+
4. graph build or rebuild if you want the graph artifacts
251
+
252
+
### 2. Read only the docs you need next
253
+
254
+
If the Hub trial was useful and you want the broader workspace path, continue with:
216
255
217
256
-`README.md`
218
257
-`docs/README.md`
219
258
-`docs/08-first-run-and-updates.md`
220
259
-`AGENTS.md`
221
260
222
-
### 2. Run the doctor script
261
+
### 3. Run the doctor script
223
262
224
263
Use the non-destructive environment check:
225
264
@@ -237,7 +276,7 @@ This reports:
237
276
- Codex-related skill and config state
238
277
- recommended setup profiles
239
278
240
-
### 2a. Bootstrap the workspace safely
279
+
### 3a. Bootstrap the workspace safely
241
280
242
281
Use the workspace bootstrap helper when you want one command that prepares the
243
282
safe cache/context folders and, if needed, installs `workspace-hub`
0 commit comments