Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
15 changes: 15 additions & 0 deletions .agents/skills/effort-graph/setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,3 +84,18 @@ On resume, begin with `flatbread effort list --status active`, then use bounded
effort-scoped reads. Capture mutation `generation` tokens and use
`--strict-min-generation` for immediate read-after-write checks; never implement
client polling loops. Semantic changes go through `flatbread effort write`.

## 4. Open the explorer (optional)

With a complete `effortGraphContent()` preset in config, Flatbread serves the
content-relation explorer automatically:

```bash
flatbread start --watch --open
```

- Explorer UI: `http://localhost:5057/`
- Apollo GraphQL sandbox: `http://localhost:5057/graphql`

No separate app install is required; `@flatbread/explorer` ships with
Comment on lines +87 to +100

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

MED — Skill implies explorer is always at http://localhost:5057/ after flatbread start --watch --open, omitting that missing dist/static soft-fails mount and --open falls back to /graphql.

Minimal fix: One sentence that built assets are required (pnpm play:efforts or explorer build) and that --open shares the mount assets gate. Mirror in the packaged skill under packages/effort-graph/skills/.

`flatbread`.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ Optional **`pnpm play`** from the repo root is a shortcut for **`cd examples/nex
- Build all packages: `pnpm build`
- **Workspace libraries (watch-only):** `pnpm dev` — runs package `dev` scripts (e.g. `tsup --watch`) for `packages/*`; it does **not** start the Next.js example.
- **Next.js example:** prefer the flow under [Recommended onboarding](#recommended-onboarding-try-flatbread-in-the-nextjs-example); or `pnpm play` as a convenience alias.
- **Effort Graph viz (`examples/effort-viz`):** after `pnpm build`, run `pnpm play:efforts` (or `pnpm --filter effort-viz dev`) to dogfood `.flatbread-efforts` with live SSE updates — see that example's README.
- **Effort Graph explorer:** after `pnpm build`, run `pnpm play:efforts` (`flatbread start --watch --open`). When `flatbread.config.js` uses `effortGraphContent()`, Flatbread serves `@flatbread/explorer` at `http://localhost:5057/` (Apollo sandbox at `/graphql`).
- Check local CI parity before opening a PR: `pnpm verify`

## Working on a package
Expand Down
2 changes: 2 additions & 0 deletions ava.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ export default {
// parser/runtime guardrails.
'!packages/codegen/src/__tests__/**',
'!packages/utils/src/__tests__/**',
// Explorer SPA uses Node's built-in test runner (see package scripts).
'!packages/explorer/**',
],
extensions: {
js: true,
Expand Down
42 changes: 0 additions & 42 deletions examples/effort-viz/.gitignore

This file was deleted.

155 changes: 0 additions & 155 deletions examples/effort-viz/README.md

This file was deleted.

47 changes: 0 additions & 47 deletions examples/effort-viz/app/layout.tsx

This file was deleted.

5 changes: 0 additions & 5 deletions examples/effort-viz/app/page.tsx

This file was deleted.

12 changes: 0 additions & 12 deletions examples/effort-viz/flatbread.config.js

This file was deleted.

7 changes: 0 additions & 7 deletions examples/effort-viz/next.config.ts

This file was deleted.

34 changes: 0 additions & 34 deletions examples/effort-viz/package.json

This file was deleted.

5 changes: 0 additions & 5 deletions examples/effort-viz/postcss.config.mjs

This file was deleted.

27 changes: 0 additions & 27 deletions examples/effort-viz/tsconfig.json

This file was deleted.

Loading
Loading