Files
fission-ai__openspec/website/lib/remark-file-steps.ts
Tabish Bidiwale f1b521dffa docs: rebuild docs site from docs-lab (#1649)
* docs: rebuild docs site from docs-lab

Replace the docs site's source tree with docs-lab, a page-by-page rebuild
of the OpenSpec docs (40 pages: Start / Guides / Customize / Multi-repo /
Reference / Help).

- Point website/docs.sync.config.mjs at ../docs-lab and restructure the
  sidebar into nested groups; sync script gains nested meta.json emission,
  leading-quote descriptions, idempotent writes, and diagram asset copying
- Remove the marketing landing page; / now redirects to /docs
  (meta-refresh page + Cloudflare _redirects)
- Add remark plugins (faq, file-steps, gfm-alert) and the FileSteps
  component backing the new page formats
- Add install.md at the repo root, curled by docs-lab/start/installation.md
  as an agent-executable install prompt
- Add the docs authoring skills (.agents/skills/{write,draft,verify}-
  openspec-docs); docs-lab/README.md links into write-openspec-docs

The old docs/ tree is now unused by the site and left for a follow-up.

Claude-Session: https://claude.ai/code/session_01BMMLYNJQPKXx1QHpnDn4ho

* docs: hold back unwritten pages, add worksets, drop diagram drafts

- website: comment out Overview, Guides, Architecture, Help, Legacy in
  docs.sync.config.mjs until those pages are written; temporary
  /docs -> /docs/installation redirect (Cloudflare _redirects + static
  export meta-refresh fallback in page.tsx)
- docs-lab: new multi-repo/worksets.md page, published under Multi-repo
- docs-lab: content revisions across start/, customize/, reference/,
  help/, multi-repo/; add review notes (Notes.md)
- remove docs-lab/diagrams option-* drafts and their website copies
- write-openspec-docs skill: add spoken-flow sentence rule

* docs: address review on PR #1649

- sync-docs: read the existing output directly instead of exists-then-read
  (CodeQL TOCTOU alert)
- hold back the headings-only Environment variables and Stores reference
  pages until written; links to them fall back to their GitHub source
- sources.md: cutover keeps docs/ in place and points at public/_redirects
- setup.md: label the workflow tree as the default set plus two optional ones

* docs: two review nits (spoken-flow rule, XDG_DATA_HOME note)
2026-08-21 20:45:19 +00:00

39 lines
1.0 KiB
TypeScript

// Turns `file-steps` fences into the interactive <FileSteps> stepper, the
// same mdxJsxFlowElement injection remarkMdxMermaid and remarkGfmAlert use.
// The fence body stays readable on GitHub: `## ` lines start a step, `> `
// lines are the step's caption, and the remaining lines are a file tree
// whose two-character gutter (`+ ` added, `- ` removed, ` ` unchanged)
// reads like a diff.
interface Node {
type: string;
lang?: string | null;
value?: string;
children?: Node[];
[key: string]: unknown;
}
function transform(node: Node): void {
if (!node.children) return;
node.children.forEach((child, index) => {
transform(child);
if (child.type !== 'code' || child.lang !== 'file-steps') return;
node.children![index] = {
type: 'mdxJsxFlowElement',
name: 'FileSteps',
attributes: [
{ type: 'mdxJsxAttribute', name: 'content', value: child.value ?? '' },
],
children: [],
};
});
}
export function remarkFileSteps() {
return (tree: Node) => {
transform(tree);
};
}