Skip to content

Commit 8ab96f1

Browse files
author
Chojan Shang
committed
docs: polish docs
Signed-off-by: Chojan Shang <chojan.shang@vesoft.com>
1 parent 90c53fe commit 8ab96f1

File tree

2 files changed

+15
-14
lines changed

2 files changed

+15
-14
lines changed

docs/releasing.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -7,27 +7,27 @@ version remain consistent.
77

88
## Preparation
99

10-
1. Pick the target schema tag (for example `v0.4.5`) and regenerate the protocol bindings:
10+
Pick the target schema tag (for example `v0.4.5`) and regenerate the protocol bindings:
1111

12-
```bash
13-
ACP_SCHEMA_VERSION=v0.4.5 make gen-all
14-
```
12+
```bash
13+
ACP_SCHEMA_VERSION=v0.4.5 make gen-all
14+
```
1515

16-
This downloads the upstream schema package and rewrites `schema/` plus the generated `src/acp/schema.py`.
16+
This downloads the upstream schema package and rewrites `schema/` plus the generated `src/acp/schema.py`.
1717

18-
2. Bump the project version in `pyproject.toml`, updating `uv.lock` if dependencies changed.
18+
Bump the project version in `pyproject.toml`, updating `uv.lock` if dependencies changed.
1919

20-
3. Run the standard checks:
20+
Run the standard checks:
2121

22-
```bash
23-
make check
24-
make test
25-
```
22+
```bash
23+
make check
24+
make test
25+
```
2626

27-
`make check` covers Ruff formatting/linting, static analysis, and dependency hygiene.
28-
`make test` executes pytest (including doctests).
27+
- `make check` covers Ruff formatting/linting, static analysis, and dependency hygiene.
28+
- `make test` executes pytest (including doctests).
2929

30-
4. Refresh documentation and examples (for instance the Gemini walkthrough) so they match the new schema behaviour.
30+
Refresh documentation and examples (for instance the Gemini walkthrough) so they match the new schema behaviour.
3131

3232
## Commit & Merge
3333

mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ copyright: Maintained by <a href="https://github.com/psiace">psiace</a>.
1010
nav:
1111
- Home: index.md
1212
- Quick Start: quickstart.md
13+
- Releasing: releasing.md
1314
plugins:
1415
- search
1516
- mkdocstrings:

0 commit comments

Comments
 (0)