Help Improvement 5 — Screenshot Section Type
Status: [To Build]
Purpose: All 26 help topics are text-only. For visual features like the pipeline, status workflows, and calendar, a screenshot cuts comprehension time significantly. Adding a
screenshotsection type is a data-shape + renderer change — no CMS needed.
Type Definition
Add to packages/common/src/help-types.ts:
export interface HelpSectionScreenshot {
kind: "screenshot";
src: string; // path relative to /public, e.g. "/help/blog-pipeline.png"
alt: string; // required for accessibility
caption?: string; // optional label below image
}
// Add to HelpSection union:
export type HelpSection =
| HelpSectionText
| HelpSectionPipeline
| HelpSectionSteps
| HelpSectionStatus
| HelpSectionFeatures
| HelpSectionActions
| HelpSectionInfo
| HelpSectionOl
| HelpSectionLinkForward
| HelpSectionScreenshot; // ← newRenderer
Add a case to the HelpPage section switch:
// packages/ui/src/HelpPage.tsx
case "screenshot": {
return (
<figure key={i} className="my-6">
<img
src={section.src}
alt={section.alt}
className="rounded-lg border w-full object-cover shadow-sm"
loading="lazy"
/>
{section.caption && (
<figcaption className="mt-2 text-center text-xs text-muted-foreground">
{section.caption}
</figcaption>
)}
</figure>
);
}Usage Example
// In _data/index.ts — blog help page
{
kind: "screenshot",
src: "/help/blog-status-flow.png",
alt: "Blog post status flow from draft to published",
caption: "A blog post moves through five stages before it is published.",
}Screenshot Storage
Screenshots live in apps/dashboard/public/help/. They are served as static assets — no CDN or S3 required for help images. Use:
- PNG for UI screenshots (lossless, crisp text)
- Max width: 1200px (retina-friendly at 600px display width)
- Filename convention:
{slug}-{description}.pnge.g.blog-status-flow.png
Priority Topics for First Screenshots
| Topic | Screenshot needed |
|---|---|
pipeline | Full pipeline diagram (Context → Strategy → Plan → Activities) |
blog | Blog status flow (draft → dm_review → client_review → approved) |
social | Social post calendar view |
activities | Activity list with filters sidebar |
calendar | Content calendar with colour-coded tiles |
context | Client context page with revision panel |
Affected Files
| File | Change |
|---|---|
packages/common/src/help-types.ts | Add HelpSectionScreenshot + add to HelpSection union |
packages/ui/src/HelpPage.tsx | Add screenshot case to section renderer |
apps/dashboard/public/help/ | New directory for screenshot assets |
apps/dashboard/src/app/(dashboard)/help/_data/index.ts | Add screenshot sections to relevant topics |