port HttpApi docs

[gcanti]

No description provided.

[github-actions]

Bundle Size Analysis

File Name	Current Size	Previous Size	Difference
basic.ts	6.20 KB	6.20 KB	0.00 KB (0.00%)
batching.ts	8.44 KB	8.44 KB	0.00 KB (0.00%)
brand.ts	6.22 KB	6.22 KB	0.00 KB (0.00%)
cache.ts	9.55 KB	9.55 KB	0.00 KB (0.00%)
config.ts	16.07 KB	16.07 KB	0.00 KB (0.00%)
differ.ts	14.29 KB	14.29 KB	0.00 KB (0.00%)
http-client.ts	18.88 KB	18.88 KB	0.00 KB (0.00%)
logger.ts	8.77 KB	8.77 KB	0.00 KB (0.00%)
metric.ts	8.69 KB	8.69 KB	0.00 KB (0.00%)
optic.ts	7.47 KB	7.47 KB	0.00 KB (0.00%)
pubsub.ts	13.06 KB	13.06 KB	0.00 KB (0.00%)
queue.ts	10.92 KB	10.92 KB	0.00 KB (0.00%)
schedule.ts	9.64 KB	9.64 KB	0.00 KB (0.00%)
schema-representation-roundtrip.ts	23.79 KB	23.79 KB	0.00 KB (0.00%)
schema-string-transformation.ts	11.23 KB	11.23 KB	0.00 KB (0.00%)
schema-string.ts	9.54 KB	9.54 KB	0.00 KB (0.00%)
schema-template-literal.ts	12.07 KB	12.07 KB	0.00 KB (0.00%)
schema-toArbitraryLazy.ts	16.30 KB	16.30 KB	0.00 KB (0.00%)
schema-toCodeDocument.ts	19.17 KB	19.17 KB	0.00 KB (0.00%)
schema-toCodecJson.ts	15.15 KB	15.15 KB	0.00 KB (0.00%)
schema-toEquivalence.ts	15.44 KB	15.44 KB	0.00 KB (0.00%)
schema-toFormatter.ts	15.29 KB	15.29 KB	0.00 KB (0.00%)
schema-toJsonSchemaDocument.ts	17.89 KB	17.89 KB	0.00 KB (0.00%)
schema-toRepresentation.ts	16.09 KB	16.09 KB	0.00 KB (0.00%)
schema.ts	14.92 KB	14.92 KB	0.00 KB (0.00%)
stm.ts	11.94 KB	11.94 KB	0.00 KB (0.00%)
stream.ts	8.40 KB	8.40 KB	0.00 KB (0.00%)

[github-actions]

📊 JSDoc Documentation Analysis

📈 Current Analysis Results

Analyzing 124 TypeScript files in packages/effect/src/ (including schema and config subdirectories)...

============================================================
         EFFECT JSDOC ANALYSIS REPORT
============================================================

📊 SUMMARY STATISTICS
------------------------------
Total files analyzed: 124
Total exported members: 4007
Missing @example: 1731 (43.2%)
Missing @category: 514 (12.8%)

🎯 TOP FILES NEEDING ATTENTION
----------------------------------------
1. Schema.ts
   📝 456 missing examples, 🏷️  262 missing categories
   📦 456 total exports
2. SchemaRepresentation.ts
   📝 92 missing examples, 🏷️  91 missing categories
   📦 92 total exports
3. Stream.ts
   📝 139 missing examples, 🏷️  0 missing categories
   📦 229 total exports
4. SchemaAST.ts
   📝 74 missing examples, 🏷️  18 missing categories
   📦 74 total exports
5. Channel.ts
   📝 75 missing examples, 🏷️  0 missing categories
   📦 144 total exports
6. Sink.ts
   📝 64 missing examples, 🏷️  2 missing categories
   📦 81 total exports
7. Predicate.ts
   📝 57 missing examples, 🏷️  0 missing categories
   📦 57 total exports
8. SchemaGetter.ts
   📝 49 missing examples, 🏷️  0 missing categories
   📦 49 total exports
9. SchemaTransformation.ts
   📝 29 missing examples, 🏷️  18 missing categories
   📦 29 total exports
10. Effect.ts
   📝 37 missing examples, 🏷️  3 missing categories
   📦 243 total exports
11. Config.ts
   📝 33 missing examples, 🏷️  5 missing categories
   📦 33 total exports
12. Cause.ts
   📝 33 missing examples, 🏷️  2 missing categories
   📦 75 total exports
13. JsonSchema.ts
   📝 17 missing examples, 🏷️  17 missing categories
   📦 17 total exports
14. Order.ts
   📝 25 missing examples, 🏷️  0 missing categories
   📦 25 total exports
15. Filter.ts
   📝 24 missing examples, 🏷️  0 missing categories
   📦 35 total exports

✅ PERFECTLY DOCUMENTED FILES
-----------------------------------
   Chunk.ts (87 exports)
   Clock.ts (5 exports)
   FiberHandle.ts (15 exports)
   FiberMap.ts (19 exports)
   FiberSet.ts (14 exports)
   HKT.ts (4 exports)
   HashMap.ts (44 exports)
   HashSet.ts (21 exports)
   Match.ts (57 exports)
   MutableHashSet.ts (9 exports)
   MutableRef.ts (17 exports)
   NonEmptyIterable.ts (3 exports)
   Random.ts (7 exports)
   Redacted.ts (9 exports)
   RegExp.ts (3 exports)
   Runtime.ts (3 exports)
   Symbol.ts (1 exports)
   Trie.ts (29 exports)
   TxChunk.ts (22 exports)
   TxHashMap.ts (41 exports)
   TxHashSet.ts (24 exports)
   TxRef.ts (7 exports)
   TxSemaphore.ts (14 exports)
   Unify.ts (8 exports)
   index.ts (0 exports)

🔍 SAMPLE MISSING ITEMS FROM Schema.ts
-----------------------------------
   Optionality (type, line 60): missing example, category
   Mutability (type, line 67): missing example, category
   ConstructorDefault (type, line 74): missing example, category
   MakeOptions (interface, line 82): missing example, category
   Bottom (interface, line 106): missing example, category
   declareConstructor (interface, line 158): missing example, category
   declareConstructor (function, line 182): missing example
   declare (interface, line 206): missing example
   declare (function, line 215): missing example, category
   revealBottom (function, line 235): missing example, category

📋 BREAKDOWN BY EXPORT TYPE
-----------------------------------
const: 846 missing examples, 157 missing categories
function: 333 missing examples, 97 missing categories
type: 182 missing examples, 87 missing categories
interface: 275 missing examples, 152 missing categories
class: 56 missing examples, 1 missing categories
namespace: 39 missing examples, 20 missing categories

📈 DOCUMENTATION PROGRESS
------------------------------
Examples: 2276/4007 (56.8% complete)
Categories: 3493/4007 (87.2% complete)

============================================================
Analysis complete! 2245 items need attention.
============================================================

📄 Detailed results saved to: jsdoc-analysis-results.json

---

This comment is automatically updated on each push. View the analysis script for details.

[gcanti]

closing in favor of #1133