Skip to content

Commit 573f1ab

Browse files
committed
fix(docs): simplify reference/api page to two language links
Remove the duplicate public-surface tables (they drifted from the generated pdoc/TypeDoc refs). Replace with two explicit links: Python -> pdoc, TypeScript -> TypeDoc. Raw <a> tags bypass the Docusaurus broken-link checker since the targets are static assets under /api/.
1 parent f206ddb commit 573f1ab

1 file changed

Lines changed: 4 additions & 34 deletions

File tree

docs/reference/api.mdx

Lines changed: 4 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -4,39 +4,9 @@ title: API Reference
44
slug: /reference/api
55
---
66

7-
## Python
7+
Full API documentation is generated from source — one curated public surface per language, kept in sync with each release.
88

9-
Full API documentation generated from source docstrings.
9+
- **Python** — <a href="/api/python/aster/public.html" target="_blank" rel="noopener">aster-rpc on pdoc &rarr;</a>
10+
- **TypeScript** — <a href="/api/typescript/" target="_blank" rel="noopener">@aster-rpc/aster on TypeDoc &rarr;</a>
1011

11-
<a href="/api/python/aster/public.html" target="_blank">Open Python API Reference &rarr;</a>
12-
13-
**Public surface:**
14-
15-
| Symbol | Description |
16-
|--------|-------------|
17-
| `AsterServer` | Declarative RPC server |
18-
| `AsterClient` | Declarative RPC client with proxy support |
19-
| `@service` | Declare an RPC service class |
20-
| `@rpc` | Mark a unary RPC method |
21-
| `@server_stream` | Mark a server-streaming method |
22-
| `@client_stream` | Mark a client-streaming method |
23-
| `@bidi_stream` | Mark a bidirectional streaming method |
24-
| `@wire_type` | Register a dataclass for cross-language serialization |
25-
| `any_of` / `all_of` | Compose capability requirements (OR / AND) |
26-
| `RpcError` | Exception raised on RPC failure |
27-
| `StatusCode` | RPC status code enum (matches gRPC codes 0--16) |
28-
| `AsterConfig` | Server/client configuration |
29-
| `CallContext` | Per-call context for interceptors |
30-
31-
## TypeScript
32-
33-
TypeScript API reference coming soon.
34-
35-
| Symbol | Description |
36-
|--------|-------------|
37-
| `AsterServer` | RPC server |
38-
| `AsterClientWrapper` | RPC client with proxy support |
39-
| `@Service` / `@Rpc` / `@ServerStream` / `@ClientStream` / `@BidiStream` | Decorators |
40-
| `@WireType` | Type registration |
41-
| `ProxyClient` | Dynamic proxy client (JSON mode) |
42-
| `RpcError` / `StatusCode` | Error handling |
12+
Both references are generated from a single curated module per language (`aster.public` for Python, `src/public.ts` for TypeScript) so the surface stays focused and aligned across bindings.

0 commit comments

Comments
 (0)