Skip to content

docs: add JSDoc categories to @fresh/core public API#3845

Open
SisyphusZheng wants to merge 1 commit into
freshframework:mainfrom
SisyphusZheng:docs/core-jsdoc
Open

docs: add JSDoc categories to @fresh/core public API#3845
SisyphusZheng wants to merge 1 commit into
freshframework:mainfrom
SisyphusZheng:docs/core-jsdoc

Conversation

@SisyphusZheng

Copy link
Copy Markdown
Contributor

What

Adds @module JSDoc block and @category tags to the @fresh/core public API entry point (packages/fresh/src/mod.ts).

All 30+ public exports are grouped into three categories:

Category Exports
Core App, ListenOptions, Context, FreshContext, Island, WebSocketHandlers, WebSocketUpgradeOptions, FreshConfig, ResolvedFreshConfig, HttpError, PageProps
Routing page, HandlerFn, HandlerByMethod, PageResponse, RouteData, RouteHandler, LayoutConfig, Lazy, MaybeLazy, RouteConfig, Method, createDefine, Define
Middleware Middleware, MiddlewareFn, railingSlashes, staticFiles, csrf/CsrfOptions, cors/CORSOptions, ipFilter/IpFilterOptions/IpFilterRules, csp/CSPOptions

Why

JSR doc score for @fresh/core reports poorly documented public symbols. This change provides structured navigation and improves discoverability without any runtime changes.

Refs #3596

Verification

Docs-only change. deno task check:types passes. No runtime behavior affected.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant