Skip to content

Commit e30e128

Browse files
committed
feat: refactor docs implementation to use deno vercel microservice instead of subprocess
1 parent fa062ff commit e30e128

7 files changed

Lines changed: 316 additions & 338 deletions

File tree

PLAN_MICRO.md

Lines changed: 0 additions & 201 deletions
This file was deleted.

PLAN_WASM.md

Lines changed: 0 additions & 110 deletions
This file was deleted.

docs-api/README.md

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
# docs-api
2+
3+
A Deno-based microservice for generating API documentation from npm packages.
4+
5+
## Overview
6+
7+
This service uses `@deno/doc` to generate documentation nodes from npm package types via esm.sh. It's designed to run on Vercel using the `vercel-deno` community runtime.
8+
9+
## Deployment
10+
11+
1. Deploy as a separate Vercel project
12+
2. Configure custom domain (e.g., `docs-api.npmx.dev`)
13+
3. Optionally set `API_SECRET` environment variable for authentication
14+
15+
## API
16+
17+
### POST /api/generate
18+
19+
Generate documentation for an npm package.
20+
21+
**Request:**
22+
23+
```json
24+
{
25+
"package": "ufo",
26+
"version": "1.5.0"
27+
}
28+
```
29+
30+
**Response (success):**
31+
32+
```json
33+
{
34+
"nodes": [...]
35+
}
36+
```
37+
38+
**Response (error):**
39+
40+
```json
41+
{
42+
"error": "not_found",
43+
"message": "Package types not found"
44+
}
45+
```
46+
47+
## Local Development
48+
49+
```bash
50+
cd docs-api
51+
deno run --allow-net --allow-env api/generate.ts
52+
```
53+
54+
## Environment Variables
55+
56+
- `API_SECRET` (optional): Bearer token for authentication

0 commit comments

Comments
 (0)