Commit d4856a6
committed
docs: stale code-block sweep + slim binding stubs + 0.1.2 install commands
Code-block sweep across the site to align with the actual public API
that shipped in aster-rpc 0.1.2 / @aster-rpc/aster 0.1.2:
- All `from aster.decorators import ...` -> `from aster import ...`
- All `from aster.codec import wire_type` -> `from aster import wire_type`
- All `from aster.types import SerializationMode` -> `from aster import SerializationMode`
(the `aster.types` module never existed -- previous docs would
ModuleNotFoundError on copy-paste)
- `scoped="stream"` -> `scoped="session"` (stream is a back-compat alias,
session is canonical and matches the framework's logging/error output)
- `AsterClient(endpoint_addr=...)` -> `AsterClient(address="aster1...")`
(endpoint_addr is a back-compat alias; address is canonical and
matches the Mission Control guide)
- `pip install aster-python` -> `pip install aster-rpc` / `aster-cli`
(aster-python was never published; the actual PyPI distributions are
aster-rpc and aster-cli, both at 0.1.2)
Quickstart (python.mdx):
- TypeScript section no longer uses @wiretype for the Hello example.
TS auto-derives wire tags the same way Python does, so the simplest
service is genuinely two decorators (@service + @rpc), not three.
Merged types.ts into service.ts to match the Python "one file" feel.
- Consumer uses the dynamic proxy (`client.proxy("HelloService")`)
which speaks JSON and needs no local type definitions, matching the
Mission Control guide style.
Define-a-service guide:
- Removed stray trailing ``` that opened an empty code block in the
bidi streaming section (markdown rendering glitch).
- Session-scoped service example now uses scoped="session" and
documents the framework's `cls(peer)` constructor contract.
- Serialization modes table updated: NATIVE now reads "deployments
where interoperability is second to performance" (clearer than
the old "single-language deployments where performance matters").
- Added "Proxy method shapes" callout showing all four RPC pattern
call forms in one place (unary/server-stream/client-stream/bidi),
to head off the recurring "I tried `await mc.tailLogs(...)` and
it crashed" QA finding.
Concepts (serialization.mdx):
- Restructured around the actual modes Aster ships: XLANG, NATIVE,
ROW, JSON. JSON is now described as the debuggability escape hatch
(the gRPC pain point Aster addresses).
- The dynamic proxy speaks JSON automatically, so any service that
supports JSON mode can be called from the shell without codegen.
Bindings/python:
- Drop create_local_client and create_session from the API surface
table -- those are internal helpers, not part of the public API.
- Sessions section now documents the actual two-sided story:
`@service(scoped="session")` on the producer + `await client.session("Name")`
on the consumer, which returns a SessionProxyClient that multiplexes
method calls over a single bidi stream.
Reference/cli.mdx:
- Install instructions point at aster-cli on PyPI (was aster-python).
Slim:
- Delete the empty placeholder index pages for bindings/{dotnet,go,jvm,rust}.
Those bindings are in progress in the framework repo but the public
docs site is Python+TypeScript only at 0.1.2; the orphaned stubs
were misleading. Will be re-added when each binding ships.
- Sidebars updated to drop the deleted entries.
- Homepage (src/pages/index.tsx + custom.css) slimmed to match the
smaller binding scope.
Mission Control guide left intact: it is the canonical user-facing
walkthrough and was already polished.1 parent 8a1e1b0 commit d4856a6
21 files changed
Lines changed: 213 additions & 374 deletions
File tree
- docs
- bindings
- dotnet
- go
- jvm
- python
- rust
- concepts
- examples
- guides
- overview
- quickstart
- reference
- src
- css
- pages
This file was deleted.
This file was deleted.
This file was deleted.
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
17 | 17 | | |
18 | 18 | | |
19 | 19 | | |
20 | | - | |
| 20 | + | |
| 21 | + | |
21 | 22 | | |
22 | 23 | | |
23 | | - | |
| 24 | + | |
24 | 25 | | |
25 | 26 | | |
26 | 27 | | |
| |||
29 | 30 | | |
30 | 31 | | |
31 | 32 | | |
32 | | - | |
33 | | - | |
| 33 | + | |
34 | 34 | | |
35 | 35 | | |
36 | 36 | | |
| |||
52 | 52 | | |
53 | 53 | | |
54 | 54 | | |
55 | | - | |
| 55 | + | |
56 | 56 | | |
57 | 57 | | |
58 | 58 | | |
| |||
86 | 86 | | |
87 | 87 | | |
88 | 88 | | |
89 | | - | |
| 89 | + | |
90 | 90 | | |
91 | | - | |
92 | | - | |
93 | 91 | | |
94 | 92 | | |
95 | 93 | | |
| |||
126 | 124 | | |
127 | 125 | | |
128 | 126 | | |
129 | | - | |
130 | | - | |
| 127 | + | |
| 128 | + | |
131 | 129 | | |
132 | 130 | | |
133 | 131 | | |
| |||
This file was deleted.
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
8 | 8 | | |
9 | 9 | | |
10 | 10 | | |
11 | | - | |
| 11 | + | |
12 | 12 | | |
13 | | - | |
| 13 | + | |
14 | 14 | | |
15 | 15 | | |
16 | 16 | | |
| |||
29 | 29 | | |
30 | 30 | | |
31 | 31 | | |
32 | | - | |
33 | | - | |
| 32 | + | |
34 | 33 | | |
35 | 34 | | |
36 | 35 | | |
37 | | - | |
| 36 | + | |
38 | 37 | | |
39 | 38 | | |
40 | 39 | | |
41 | | - | |
42 | | - | |
| 40 | + | |
| 41 | + | |
43 | 42 | | |
44 | | - | |
| 43 | + | |
45 | 44 | | |
46 | 45 | | |
47 | 46 | | |
48 | | - | |
49 | | - | |
50 | 47 | | |
51 | | - | |
52 | | - | |
53 | | - | |
| 48 | + | |
| 49 | + | |
| 50 | + | |
54 | 51 | | |
55 | | - | |
| 52 | + | |
56 | 53 | | |
57 | 54 | | |
58 | | - | |
| 55 | + | |
59 | 56 | | |
60 | 57 | | |
61 | 58 | | |
| |||
66 | 63 | | |
67 | 64 | | |
68 | 65 | | |
69 | | - | |
| 66 | + | |
70 | 67 | | |
71 | 68 | | |
72 | 69 | | |
| |||
0 commit comments