docs: Add docstrings for ideation route handler and view components

This commit is contained in:
Monoquark
2026-01-24 13:30:09 +01:00
parent 1ecb97b71c
commit a3c62e8358
2 changed files with 14 additions and 1 deletions

View File

@@ -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<void> => {
try {

View File

@@ -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();