Skip to content

docs: add Z.AI GLM coding plan setup guide#749

Merged
chumyin merged 3 commits into
zeroclaw-labs:mainfrom
adisusilayasa:docs/zai-glm-setup-guide-v2
Feb 18, 2026
Merged

docs: add Z.AI GLM coding plan setup guide#749
chumyin merged 3 commits into
zeroclaw-labs:mainfrom
adisusilayasa:docs/zai-glm-setup-guide-v2

Conversation

@adisusilayasa
Copy link
Copy Markdown
Contributor

@adisusilayasa adisusilayasa commented Feb 18, 2026

Summary

  • Problem: Z.AI setup guidance was added, but model/default details drifted from current runtime behavior and the PR also mixed in CI workflow edits.
  • Why it matters: setup docs should match provider/onboard behavior, and docs PRs should avoid unrelated CI churn.
  • What changed:
    • Added a dedicated docs/zai-glm-setup.md guide.
    • Updated .env.example with Z.AI setup hints.
    • Aligned docs to current defaults (glm-5) and current Z.AI alias/endpoint behavior (zai, zai-cn).
    • Removed incidental workflow edits from this PR to keep scope docs-focused.
  • What did not change (scope boundary): no runtime/provider/tool code paths changed.

Linked Issue

Validation Evidence (required)

Commands and result summary:

git diff --check
./scripts/ci/docs_quality_gate.sh
  • Evidence provided (test/log/trace/screenshot/perf): local command output (no whitespace issues; markdownlint passed for docs/zai-glm-setup.md).
  • If any command is intentionally skipped, explain why: Rust fmt/clippy/test were skipped because this PR is docs/env-only and changes no Rust source.

Security Impact (required)

  • New permissions/capabilities? (No)
  • New external network calls? (No)
  • Secrets/tokens handling changed? (No)
  • File system access scope changed? (No)
  • If any Yes, describe risk and mitigation: N/A

Privacy and Data Hygiene (required)

  • Data-hygiene status (pass)
  • Redaction/anonymization notes: only placeholder key format examples are used.
  • Neutral wording confirmation: wording is project-neutral and system-focused.

Rollback Plan (required)

  • Fast rollback command/path: git revert <merge_commit_sha> after merge.
  • Feature flags or config toggles (if any): none.
  • Observable failure symptoms: documentation mismatch or confusion in setup steps.

- Add comprehensive documentation for Z.AI GLM models
- Include curl examples for testing Z.AI API
- Document available models and troubleshooting
- Update .env.example with Z.AI configuration

Z.AI provides GLM models (glm-4.5, glm-4.6, glm-4.7, glm-5) through
the OpenAI-compatible endpoint at api.z.ai/api/coding/paas/v4.

Existing tests verify:
- zai_base_url() returns correct URLs for global/CN variants
- create_provider('zai', key) successfully creates provider
- Regional alias predicates cover all variants
@github-actions
Copy link
Copy Markdown

github-actions Bot commented Feb 18, 2026

PR intake checks found warnings (non-blocking)

Fast safe checks found advisory issues. CI lint/test/build gates still enforce merge quality.

  • Incomplete required PR template fields: security risk/mitigation, privacy status

Action items:

  1. Complete required PR template sections/fields.
  2. Remove tabs, trailing whitespace, and merge conflict markers from added lines.
  3. Re-run local checks before pushing:
    • ./scripts/ci/rust_quality_gate.sh
    • ./scripts/ci/rust_strict_delta_gate.sh
    • ./scripts/ci/docs_quality_gate.sh

Run logs: https://github.com/zeroclaw-labs/zeroclaw/actions/runs/22130130157

Detected blocking line issues (sample):

  • none

Detected advisory line issues (sample):

  • none

@github-actions github-actions Bot added docs Auto scope: docs/markdown/template files changed. size: XS Auto size: <=80 non-doc changed lines. risk: low Auto risk: docs/chore-only paths. labels Feb 18, 2026
The first-interaction action requires snake_case input names.
This fix is needed for CI to pass on this PR.
@github-actions github-actions Bot added ci Auto scope: CI/workflow/hook files changed. risk: high Auto risk: security/runtime/gateway/tools/workflows. and removed risk: low Auto risk: docs/chore-only paths. labels Feb 18, 2026
@chumyin chumyin self-assigned this Feb 18, 2026
- remove trailing whitespace in .env.example Z.AI block
- align documented model defaults/options with current onboard/provider behavior
- keep this PR docs-focused by reverting incidental workflow edits
@github-actions github-actions Bot added risk: low Auto risk: docs/chore-only paths. and removed ci Auto scope: CI/workflow/hook files changed. risk: high Auto risk: security/runtime/gateway/tools/workflows. labels Feb 18, 2026
@chumyin
Copy link
Copy Markdown
Contributor

chumyin commented Feb 18, 2026

Thanks @adisusilayasa, and congratulations on the contribution — this is a helpful docs addition.\n\nI applied a maintainer polish pass to keep the PR accurate and focused:\n- aligned the Z.AI setup guide with current runtime/onboard defaults and provider aliases\n- removed the trailing whitespace advisory in \n- reverted incidental workflow edits so this remains a docs-focused PR\n\n@willsarg heads-up: I handled the docs + CI-scope cleanup by keeping this PR docs-only and leaving CI workflow work in dedicated CI tracks (for example #732).\n\nAll relevant checks are passing on the updated head.

@chumyin
Copy link
Copy Markdown
Contributor

chumyin commented Feb 18, 2026

Thanks again @adisusilayasa — and congratulations on shipping a clear Z.AI docs improvement.

Quick correction to my previous note: the whitespace cleanup was in .env.example.

Final maintainer updates applied on this PR:

  • aligned docs/zai-glm-setup.md with current runtime/onboard defaults and aliases
  • cleaned formatting in .env.example
  • reverted incidental workflow edits so this PR stays docs-only

@willsarg this one is now intentionally docs-only; CI workflow changes remain in dedicated CI PRs (for example #732).

@chumyin chumyin merged commit a3eedfd into zeroclaw-labs:main Feb 18, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Auto scope: docs/markdown/template files changed. risk: low Auto risk: docs/chore-only paths. size: XS Auto size: <=80 non-doc changed lines.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants