docs(changelog): fix 0.32.0 entry formatting and doc links - #2598
Conversation
|
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 193c8dd421
ℹ️ About Codex in GitHub
Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".
| - Rename two `[loop_control]` keys: `max_retries_per_step` → `max_attempts_per_step` and `max_steps_per_run` → `max_steps_per_turn`; the old keys stop working with a rename warning at startup — see [loop_control](https://moonshotai.github.io/kimi-code/en/configuration/config-files.html#loop-control). | ||
| - Add a `[token_counting]` config section: when a provider doesn't report token usage, switch the context-size display to local estimates — see [token_counting](https://moonshotai.github.io/kimi-code/en/configuration/config-files.html#token-counting). |
There was a problem hiding this comment.
These two link labels are config section identifiers, but the change removes the inline-code styling from loop_control and token_counting in the English changelog (and the Chinese mirror does the same). That leaves the updated changelog inconsistent with the docs style rule for field names/values and with the new skill guidance that says to code-style identifier link text inside the brackets; please make the labels [`loop_control`](...) and [`token_counting`](...) in both locales.
AGENTS.md reference: docs/AGENTS.md:L52-L52
Useful? React with 👍 / 👎.
| - Update the native release workflow to use current GitHub artifact actions. | ||
| ``` | ||
|
|
||
| Doc links: an entry that changes a documented config surface may end with a pointer to the docs page — `see [X](...) for details` (Chinese: `详见 [X](...)。`). Keep it a real Markdown link into the docs tree with a relative path (for example `../configuration/config-files.md#loop-control`). When the link text is a config key or another identifier, code-style the text inside the brackets: [`loop_control`](../configuration/config-files.md#loop-control). Never wrap the whole link in backticks — `` `[loop_control](...)` `` renders as raw inline code that exposes the relative path instead of a clickable link. |
There was a problem hiding this comment.
This new instruction still tells future sync-changelog runs to emit relative docs links, but this commit changed the 0.32.0 entries to absolute https://moonshotai.github.io/kimi-code/... URLs because changelog snippets are pasted outside the docs site. The next config-surface changelog entry generated from this skill will reintroduce the same non-resolving pasted links, so the guidance should either require the published absolute URL format or the docs entries should remain relative consistently.
Useful? React with 👍 / 👎.
1 participant
Related Issue
N/A — post-release docs maintenance
Problem
The 0.32.0 changelog entries had several rendering problems, most visible when the text is pasted into chat tools:
SessionEnd-reporting clause with no user-facing value.What changed
docs/zh+docs/en0.32.0: drop theSessionEnd-as-archivereporting clause; keep only the new hook events and how to configure them.https://moonshotai.github.io/kimi-code/...), with plain link text instead of code-styled.config.toml,/login).sync-changelogskill: drop hook/event payload-mechanics clauses; document the doc-link format (real Markdown links, never backtick-wrapped); add matching Verify / Common Mistakes entries.pre-changelogskill: rewrite preview doc links to absolute published URLs, since the preview is pasted into chat tools.pnpm -C docs run build; anchors#loop-control/#token-countingexist on the target pages.Checklist
gen-changesetsskill, or this PR needs no changeset. (No changeset — docs and agent-skill guidance only, nothing enters package output)gen-docsskill, or this PR needs no doc update. (This PR is the doc update)