imbajin commented on PR #558:
URL: https://github.com/apache/hugegraph-doc/pull/558#issuecomment-6579374034
Thanks for the thorough review @bitflicker64!
We have resolved all conflicts against `origin/master` (rebased on
`19e2573f1` which merged PR #557) and updated the documentation:
1. **Version & Feature Boundary**:
- Added explicit note callouts (`> [!NOTE]`) in both English and Chinese
guides explaining the version boundary between released PyPI 1.7.x packages
(CamelCase baseline) and modern master development features (`snake_case`,
`client.olap()`, `client.task().wait()`, `client.close()`, and updated
traverser signatures from `apache/hugegraph-ai#392`).
- Added clear source installation tabs (`git clone ... && cd
hugegraph-python-client && pip install -e .` and `uv sync --extra
python-client`) for developers testing master features alongside standard PyPI
install instructions.
2. **Navigation & Route Alignment**:
- Unified all quick start and API reference materials cleanly into
`content/{en,cn}/docs/clients/client/hugegraph-client-python.md`, fully aligned
with the client directory reorganization from PR #557.
- Kept `data/docs_nav.json` and `data/version_routes.json` intact and
consistent with `origin/master`.
- Preserved `sameneighborsbatch` endpoints in `traverser.md` from PR #557
while incorporating REST references to the Python client guide in `rank.md`,
`task.md`, and `traverser.md`.
3. **Writing & Typography**:
- Removed robotic AI disclaimers and phrasing, polishing to natural,
idiomatic technical documentation.
- Adopted OINK component features (`{tab="..."}`, `{.steps}`, `{.wide
.expand}`).
- Formatted all prose to <= 160 characters per line.
4. **Validation**:
- `./scripts/hugo.sh build`: 668 pages rendered with 0 errors.
- `bash dist/validate-links.sh`: 0 broken links.
- `python3 -m unittest discover -s scripts/`: All 290 unit tests pass.
- `git diff --check`: 0 issues.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]