From a3c62e8358341b579d984ec5019a8983165fed7e Mon Sep 17 00:00:00 2001 From: Monoquark Date: Sat, 24 Jan 2026 13:30:09 +0100 Subject: [PATCH] docs: Add docstrings for ideation route handler and view components --- .../src/routes/ideation/routes/suggestions-generate.ts | 5 +++++ apps/ui/src/components/views/ideation-view/index.tsx | 10 +++++++++- 2 files changed, 14 insertions(+), 1 deletion(-) diff --git a/apps/server/src/routes/ideation/routes/suggestions-generate.ts b/apps/server/src/routes/ideation/routes/suggestions-generate.ts index 1aa7487b..ffb4e8ac 100644 --- a/apps/server/src/routes/ideation/routes/suggestions-generate.ts +++ b/apps/server/src/routes/ideation/routes/suggestions-generate.ts @@ -10,6 +10,11 @@ import { getErrorMessage, logError } from '../common.js'; const logger = createLogger('ideation:suggestions-generate'); +/** + * Creates an Express route handler for generating AI-powered ideation suggestions. + * Accepts a prompt, category, and optional context sources configuration, + * then returns structured suggestions that can be added to the board. + */ export function createSuggestionsGenerateHandler(ideationService: IdeationService) { return async (req: Request, res: Response): Promise => { try { diff --git a/apps/ui/src/components/views/ideation-view/index.tsx b/apps/ui/src/components/views/ideation-view/index.tsx index 1346d925..39f72b04 100644 --- a/apps/ui/src/components/views/ideation-view/index.tsx +++ b/apps/ui/src/components/views/ideation-view/index.tsx @@ -62,7 +62,10 @@ function IdeationBreadcrumbs({ ); } -// Header shown on all pages - matches other view headers +/** + * Header component for the ideation view with navigation, bulk actions, and settings. + * Displays breadcrumbs, accept/discard all buttons, and the generate ideas button with settings popover. + */ function IdeationHeader({ currentMode, selectedCategory, @@ -172,6 +175,11 @@ function IdeationHeader({ ); } +/** + * Main view for brainstorming and idea management. + * Provides a dashboard for reviewing generated ideas and a prompt selection flow + * for generating new ideas using AI-powered suggestions. + */ export function IdeationView() { const currentProject = useAppStore((s) => s.currentProject); const { currentMode, selectedCategory, setMode, setCategory } = useIdeationStore();