docs: refine JSDoc usage guidance

[gcanti]

No description provided.

[changeset-bot]

🦋 Changeset detected

Latest commit: f8762b9

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 27 packages

Name	Type
effect	Patch
@effect/opentelemetry	Patch
@effect/platform-browser	Patch
@effect/platform-bun	Patch
@effect/platform-node-shared	Patch
@effect/platform-node	Patch
@effect/vitest	Patch
@effect/ai-anthropic	Patch
@effect/ai-openai-compat	Patch
@effect/ai-openai	Patch
@effect/ai-openrouter	Patch
@effect/atom-react	Patch
@effect/atom-solid	Patch
@effect/atom-vue	Patch
@effect/sql-clickhouse	Patch
@effect/sql-d1	Patch
@effect/sql-libsql	Patch
@effect/sql-mssql	Patch
@effect/sql-mysql2	Patch
@effect/sql-pg	Patch
@effect/sql-pglite	Patch
@effect/sql-sqlite-bun	Patch
@effect/sql-sqlite-do	Patch
@effect/sql-sqlite-node	Patch
@effect/sql-sqlite-react-native	Patch
@effect/sql-sqlite-wasm	Patch
@effect/openapi-generator	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[github-actions]

Bundle Size Analysis

File Name	Current Size	Previous Size	Difference
basic.ts	6.72 KB	6.72 KB	0.00 KB (0.00%)
batching.ts	9.23 KB	9.23 KB	0.00 KB (0.00%)
brand.ts	6.20 KB	6.20 KB	0.00 KB (0.00%)
cache.ts	9.70 KB	9.70 KB	0.00 KB (0.00%)
config.ts	18.40 KB	18.40 KB	0.00 KB (0.00%)
differ.ts	16.85 KB	16.85 KB	0.00 KB (0.00%)
http-client.ts	20.20 KB	20.20 KB	0.00 KB (0.00%)
logger.ts	10.18 KB	10.18 KB	0.00 KB (0.00%)
metric.ts	8.56 KB	8.56 KB	0.00 KB (0.00%)
optic.ts	7.37 KB	7.37 KB	0.00 KB (0.00%)
pubsub.ts	13.80 KB	13.80 KB	0.00 KB (0.00%)
queue.ts	11.08 KB	11.08 KB	0.00 KB (0.00%)
schedule.ts	10.08 KB	10.08 KB	0.00 KB (0.00%)
schema-representation-roundtrip.ts	26.24 KB	26.24 KB	+0.00 KB (+0.00%)
schema-string-transformation.ts	12.59 KB	12.59 KB	0.00 KB (0.00%)
schema-string.ts	10.34 KB	10.34 KB	0.00 KB (0.00%)
schema-template-literal.ts	13.94 KB	13.94 KB	0.00 KB (0.00%)
schema-toArbitraryLazy.ts	18.51 KB	18.51 KB	0.00 KB (0.00%)
schema-toCodeDocument.ts	21.13 KB	21.13 KB	0.00 KB (0.00%)
schema-toCodecJson.ts	17.67 KB	17.67 KB	0.00 KB (0.00%)
schema-toEquivalence.ts	17.61 KB	17.61 KB	0.00 KB (0.00%)
schema-toFormatter.ts	17.44 KB	17.44 KB	0.00 KB (0.00%)
schema-toJsonSchemaDocument.ts	19.96 KB	19.96 KB	0.00 KB (0.00%)
schema-toRepresentation.ts	18.00 KB	18.00 KB	0.00 KB (0.00%)
schema.ts	17.05 KB	17.05 KB	0.00 KB (0.00%)
stm.ts	11.95 KB	11.95 KB	0.00 KB (0.00%)
stream.ts	9.25 KB	9.25 KB	0.00 KB (0.00%)