Files
PaperClipAI/ui/storybook/support/feature-map/FeatureOverview.tsx
T
DottaandPaperclip 433d94ee0b refactor(maps): generate indexes from local story and feature metadata (#16214)
## Thinking Path

> - Paperclip is the open source app people use to manage AI agents for
work.
> - Feature recipes and Storybook help contributors find behavior,
examples, and verification steps.
> - Independent feature changes currently update shared catalogs,
indexes, and review hashes.
> - Those shared files cause merge conflicts and repeated bookkeeping
during parallel work.
> - This pull request stores metadata in each feature recipe and story,
then generates the combined views.
> - Contributors can merge independent work without editing a common
index. Git and PR evidence retain change and review history.

## Linked Issues or Issue Description

**What existing behavior does this improve?**

Maintaining the product, agent-access, and Storybook maps while multiple
agents change different features.

**Current behavior**

A story or recipe change can update `catalog.json`, `INDEX.md`, review
hashes, verification tables, and tracked generated navigation. Two
unrelated changes then conflict in the same files.

**Proposed behavior**

Each story declares capability links and classification in
`parameters.paperclip`. Each feature recipe declares its navigation and
optional verification guidance. Startup, build, and UI typechecking
discover these sources and generate ignored indexes and Storybook pages.

**Reason and benefit**

A routine change edits its own source files. Aggregate metadata is
rebuilt from the merged checkout. There is no sidecar registry, shared
review journal, or hash acknowledgment to maintain.

**Breaking changes**

The tracked Storybook catalog and index paths are retired. Consumers use
`ui/storybook/generated/` or `maps/generated/` after generation.
Contributor instructions and the existing feature-gap browser suite use
the new paths. Story and overview IDs remain stable.

## What Changed

- Move the existing annotations into 262 story files. Preserve
classifications, capability associations, exports, and explicit IDs.
- Discover all 35 feature recipes. Store section/order beside each
recipe and move durable verification routes out of the shared table.
- Remove tracked catalogs, inventories, overview pages, and inline
preview ordering. Keep authored preview behavior in `preview-base.tsx`.
- Generate the Storybook guide, feature/access Markdown indexes, gap
report, page-reference inventory, and preview wrapper automatically.
- Update the map contracts and maintenance skills to use Git history and
revision-specific PR/CI evidence.
- Add schema, identity, regeneration, and actual Git merge tests. Run
these through the existing UI Vitest suite. Add focused browser
navigation checks.

This is one coordinated migration. Most of the 367 changed files contain
only moved metadata or deleted generated content. Review the generator
scripts, map contracts, Storybook configuration, and tests first. No
product API or authorization behavior changes.

## Verification

Passed:

- `node scripts/check-maps.mjs`: 35 paired areas and 175 capabilities.
- `node scripts/storybook-catalog.mjs --check`: 262 suites and 2,485
authored stories after incorporating current master.
- `node --test scripts/check-maps.test.mjs
scripts/storybook-catalog.test.mjs
scripts/storybook-feature-index.test.mjs`: 28 tests, including
independent branches merged in both orders with identical generated
output and no tracked changes.
- `pnpm --filter @paperclipai/ui exec vitest run
storybook/map-tooling.test.ts`: the CI entrypoint runs those map tests.
- `pnpm check:token-gates`.
- `pnpm -r typecheck` and `pnpm build` before the final master rebase.
- `pnpm build-storybook`: all 2,517 original story/docs URLs retained.
Current master contributes exactly four additional recovery stories.
- Focused Playwright navigation checks: search and open a feature
without examples; expand verification guidance and check source links;
retain capability order and follow a related Foundations suite.

The final clean Storybook build passed after deleting every ignored map
output. Post-rebase UI typechecking and both browser tests passed. The
working tree stays clean after generation. The concurrent-cleanup
regression fails with `ENOENT` without the fix and passes with it.

All GitHub CI gates passed on `00fc7ec18e`, which also received Greptile
5/5 with no unresolved findings. The final merge commit `1c3c5143a6`
incorporates master and resolves only the two modify/delete conflicts by
retaining removal of the aggregate index and catalog. Master’s new
workspace feature and access guidance is preserved. Map validation,
catalog generation, overview generation, all 28 map tests, and diff
checks pass after conflict resolution. The maintainer explicitly
requested merging without another Greptile review. CI has not been rerun
to completion on this merge commit. The local repository-wide `pnpm
test:run` was stopped before completion after the earlier CI matrix
passed; it is not reported as a local pass. No screenshot baselines or
production acceptance are claimed.

To repeat the browser check against an owned Storybook server:

```sh
PAPERCLIP_GAP_STORYBOOK_URL=http://127.0.0.1:6136 pnpm exec playwright test --config tests/storybook-visual/feature-gap-stories.config.ts map-navigation.spec.ts
```

## Risks

- Existing branches need a one-time rebase to move their catalog changes
into local annotations. The PR incorporates the recovery changes from
current master.
- Changing the same story or capability can still produce a meaningful
conflict. This removes the shared aggregate bottleneck.
- The generator uses Storybook's existing CSF parser. Literal-only
annotations and parser regression tests protect the current contract.
- Generated Markdown is available after running the generator; the
published Storybook provides a browsable guide.
- Shared source changes still require review. Removing hashes removes
mechanical acknowledgments; it does not establish runtime parity.

## Model Used

OpenAI Codex, based on GPT-6, with repository inspection, code
execution, and browser-test tools. The exact deployment model ID and
context window were not exposed in this session.

## Checklist

- [x] I have included a thinking path that traces from project context
to this change
- [x] I have specified the model used (with version and capability
details)
- [x] I have checked ROADMAP.md and confirmed this PR does not duplicate
planned core work
- [x] I have searched GitHub for duplicate or related PRs and linked
them above
- [x] I have either (a) linked existing issues with `Fixes: #` / `Closes
#` / `Refs #` OR (b) described the issue in-PR following the relevant
issue template
- [x] I have not referenced internal/instance-local Paperclip issues or
links (only public GitHub `#NNN` / `github.com/paperclipai/paperclip`
URLs)
- [x] My branch name describes the change (e.g. `docs/...`, `fix/...`)
and contains no internal Paperclip ticket id or instance-derived details
- [x] I have run tests locally and they pass
- [x] I have added or updated tests where applicable
- [x] I have updated relevant documentation to reflect my changes
- [x] I have considered and documented any risks above
- [x] All Paperclip CI gates are green on the previously reviewed head
`00fc7ec18e`; final conflict-resolution checks are documented above
- [x] Greptile is 5/5 with no open P2s, recommendations, or follow-ups
on `00fc7ec18e`; another review was waived by the maintainer
- [x] I will address all Greptile and reviewer comments before
requesting merge

---------

Co-authored-by: Paperclip <noreply@paperclip.ing>
2026-10-13 15:27:23 -05:00

163 lines
9.9 KiB
TypeScript

import { useEffect, useMemo, useState } from "react";
import ReactMarkdown, { defaultUrlTransform } from "react-markdown";
import { Badge } from "@/components/ui/badge";
import { Input } from "@/components/ui/input";
import catalog from "../../generated/catalog.json";
import featureIndex from "../../generated/feature-index.json";
type Entry = Omit<(typeof catalog.entries)[number], "capabilities" | "home"> & { capabilities: string[]; home?: string };
const entries: Entry[] = catalog.entries;
type IndexEntry = { id: string; type: string; importPath: string };
type Capability = {
id: string;
label: string;
description: string;
verification?: { scope: string; storybook: string; production: string; sources: string };
};
type Feature = { id: string; title: string; description: string; capabilities: Capability[] };
const recipeRoot = "https://github.com/paperclipai/paperclip/blob/master/maps/feature-map/";
const allFeatures: Feature[] = featureIndex.sections.flatMap(section => section.features);
const examples = entries.filter(entry => entry.implementation !== "guide");
const featureHref = (id: string) => `./?path=/story/feature-map-${id}--overview`;
function useStoryLinks() {
const [links, setLinks] = useState<Record<string, string>>({});
const [error, setError] = useState(false);
useEffect(() => {
const controller = new AbortController();
void fetch(new URL("index.json", window.location.href), { signal: controller.signal })
.then(response => {
if (!response.ok) throw new Error("Story index unavailable");
return response.json() as Promise<{ entries: Record<string, IndexEntry> }>;
})
.then(index => {
const next: Record<string, string> = {};
for (const entry of Object.values(index.entries)) {
if (entry.type !== "story") continue;
const file = `ui/${entry.importPath.replace(/^\.\//, "")}`;
next[file] ??= `./?path=/story/${entry.id}`;
}
setLinks(next);
})
.catch(() => { if (!controller.signal.aborted) setError(true); });
return () => controller.abort();
}, []);
return { links, error };
}
function SuiteLink({ entry, links }: { entry: Entry; links: Record<string, string> }) {
return (
<li className="space-y-2 py-3">
<div className="flex flex-wrap items-center gap-2">
{links[entry.file]
? <a className="font-medium underline underline-offset-4" href={links[entry.file]} target="_top">{entry.purpose}</a>
: <span className="font-medium">{entry.purpose}</span>}
<Badge variant="outline">{entry.status}</Badge>
<Badge variant="outline">{entry.implementation}</Badge>
<Badge variant="outline">{entry.boundary}</Badge>
</div>
<p className="text-sm text-muted-foreground">{entry.notes}</p>
</li>
);
}
export function FeatureMapIndex() {
const [query, setQuery] = useState("");
const { links, error } = useStoryLinks();
const search = query.trim().toLowerCase();
const sections = useMemo(() => featureIndex.sections.map(section => ({
...section,
features: section.features.filter(feature => {
const related = entries.filter(entry => entry.capabilities.some(ref => ref.startsWith(`${feature.id}/`)));
return [section.title, feature.title, feature.id, feature.description,
...feature.capabilities.flatMap(capability => [capability.id, capability.label, capability.description]),
...related.flatMap(entry => [entry.file, entry.purpose, entry.status, entry.implementation]),
].join(" ").toLowerCase().includes(search);
}),
})).filter(section => section.features.length), [search]);
const foundations = examples.filter(entry => (entry.home === "foundations" || !entry.capabilities.length)
&& ["Shared foundations", entry.file, entry.purpose, entry.status, entry.implementation, entry.boundary].join(" ").toLowerCase().includes(search));
return (
<main className="paperclip-story__inner space-y-6 p-6">
<header className="space-y-3">
<h1 className="text-2xl font-semibold">Paperclip feature map</h1>
<p className="text-sm text-muted-foreground">The same product index as the feature map, with Storybook examples alongside each capability.</p>
<p className="text-sm text-muted-foreground">{allFeatures.length} feature families · {allFeatures.reduce((count, feature) => count + feature.capabilities.length, 0)} capabilities. Examples are fixtures and references, not proof of production behavior.</p>
<a className="text-sm underline underline-offset-4" href={`${recipeRoot}README.md`} target="_blank" rel="noreferrer">Read the feature-map index</a>
<Input aria-label="Find a feature or capability" placeholder="Find a feature, capability, or example…" value={query} onChange={event => setQuery(event.target.value)} />
</header>
{sections.length === 0 && foundations.length === 0 ? <p>No matching features or examples.</p> : null}
{sections.map(section => (
<section key={section.title} className="space-y-3">
<h2 className="text-lg font-semibold">{section.title}</h2>
<ul className="divide-y divide-border">
{section.features.map(feature => {
const suites = examples.filter(entry => entry.capabilities.some(ref => ref.startsWith(`${feature.id}/`)));
return (
<li key={feature.id} className="space-y-2 py-3">
<div className="flex flex-wrap items-center gap-2">
<a className="font-medium underline underline-offset-4" href={featureHref(feature.id)} target="_top">{feature.title}</a>
<span className="text-sm text-muted-foreground">{suites.length ? `${suites.length} related example ${suites.length === 1 ? "suite" : "suites"}` : "No cataloged examples yet"}</span>
</div>
<p className="text-sm text-muted-foreground">{feature.description}</p>
</li>
);
})}
</ul>
</section>
))}
{foundations.length ? (
<section className="space-y-3">
<h2 className="text-lg font-semibold">Shared foundations</h2>
<p className="text-sm text-muted-foreground">Shared UI components sit outside the product feature index.</p>
{error ? <p role="alert">Example links could not load. Reload to try again.</p> : null}
<ul className="divide-y divide-border">{foundations.map(entry => <SuiteLink key={entry.file} entry={entry} links={links} />)}</ul>
</section>
) : null}
</main>
);
}
export function FeatureOverview({ area }: { area: string }) {
const feature = allFeatures.find(item => item.id === area);
const { links, error } = useStoryLinks();
if (!feature) return <p role="alert">This feature is not in the feature-map index.</p>;
const guides = entries.filter(entry => entry.implementation === "guide" && entry.capabilities.some(ref => ref.startsWith(`${area}/`)));
return (
<main className="paperclip-story__inner space-y-6 p-6">
<header className="space-y-3">
<a className="text-sm underline underline-offset-4" href="./?path=/story/overview-storybook-guide--coverage-guide" target="_top">All features</a>
<h1 className="text-2xl font-semibold">{feature.title}</h1>
<p className="text-muted-foreground">{feature.description}</p>
<a className="text-sm underline underline-offset-4" href={`${recipeRoot}${area}.md`} target="_blank" rel="noreferrer">Feature recipe and verification steps</a>
<a className="ml-3 text-sm underline underline-offset-4" href={`${recipeRoot}../agent-access-map/${area}.md`} target="_blank" rel="noreferrer">Agent access contract</a>
<p className="text-sm text-muted-foreground">Capabilities follow the feature recipe in the same order. Related suites may live under another feature. A suite link does not establish that every behavior has an example or passed a test.</p>
{error ? <p role="alert">Example links could not load. Reload to try again.</p> : null}
</header>
<nav aria-label="Capabilities" className="flex flex-wrap gap-3">
{feature.capabilities.map(capability => <a key={capability.id} className="text-sm underline underline-offset-4" href={`#${capability.id.split("/")[1]}`}>{capability.label}</a>)}
</nav>
{feature.capabilities.map(capability => {
const suites = examples.filter(entry => entry.capabilities.includes(capability.id));
return (
<section key={capability.id} id={capability.id.split("/")[1]} className="space-y-3">
<h2 className="text-lg font-semibold">{capability.label}</h2>
<code className="text-xs text-muted-foreground">{capability.id}</code>
<div className="text-sm text-muted-foreground"><ReactMarkdown>{capability.description}</ReactMarkdown></div>
{suites.length
? <ul className="divide-y divide-border">{suites.map(entry => <SuiteLink key={entry.file} entry={entry} links={links} />)}</ul>
: <p className="text-sm">No cataloged example yet. Use the feature recipe for entry points, verification steps, and known limits.</p>}
{capability.verification ? <details className="space-y-3 text-sm">
<summary className="cursor-pointer">Verification scope</summary>
<p>{capability.verification.storybook}</p>
<p><strong>Production verification: </strong>{capability.verification.production}</p>
<ReactMarkdown urlTransform={url => defaultUrlTransform(new URL(url, `${recipeRoot}${area}.md`).href)}>{capability.verification.sources}</ReactMarkdown>
</details> : null}
</section>
);
})}
{guides.length ? <section className="space-y-3"><h2 className="text-lg font-semibold">Related guides</h2><ul className="divide-y divide-border">{guides.map(entry => <SuiteLink key={entry.file} entry={entry} links={links} />)}</ul></section> : null}
</main>
);
}