docs: empty flag values - #365
Conversation
A pipeline that has been quietly passing an empty flag value starts failing on the release that refuses it, and the person it fails for reads the docs, not the release notes. The FAQ section follows the boolean-flags one it sits below: the failing command, the error verbatim, why the value is usually empty, and what to do about it. The changelog entry says the accepting was the bug, so a new failure reads as a diagnosis rather than a regression. Both carry vX.Y.0 as a placeholder until the release version is decided.
Both sides add to the top of the changelog, so changelog/index.mdx conflicted. Kept both, with the unreleased empty-flag-values entry above main's August entries, since it describes a release that has not happened yet. Main's side also brings the regenerated client_reference pages, which carry the flag-type column from #1068. That accounts for most of the file count here.
The FAQ and changelog were written before the version was known. A customer reading either needs to know which version changed under them, so the version is the part that cannot stay a placeholder.
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
|
Claude finished @mbevc1's task in 1m 6s —— View job Review of PR #365 — Empty flag values
Previously flagged issues — all resolved ✓ The placeholder date (
|
![claude[bot]](https://avatars.githubusercontent.com/in/1236702?s=60&v=4){kind=small}
changelog/index.mdx conflicted again because both sides add entries at the top. Kept both, with the unreleased v2.37.0 entry above main's August 11-14 entries. Main's newest CLI release is v2.36.6, so v2.37.0 remains the next version. Worth noting the pattern: this file will conflict on every merge while the branch is open, always the same way and always resolved the same way. If that becomes tiresome, the alternative is to keep the changelog entry out of this branch and add it at release time, when the date is known anyway. Merge branch 'main' into empty-flag-values
| rss: true | ||
| --- | ||
|
|
||
| <Update label="MONTH DD, 2026" description="v2.37.0" tags={["CLI"]}> |
There was a problem hiding this comment.
Critical — Placeholder date
"MONTH DD, 2026" is still a placeholder. Every other changelog entry uses a real date. This will render as-is on the live site.
| <Update label="MONTH DD, 2026" description="v2.37.0" tags={["CLI"]}> | |
| <Update label="August 18, 2026" description="v2.37.0" tags={["CLI"]}> |
Adjust the date to match the actual release date.
Co-authored-by: claude[bot] <209825114+claude[bot]@users.noreply.github.com>
| rss: true | ||
| --- | ||
|
|
||
| <Update label="MONTH DD, 2026" description="v2.37.0" tags={["CLI"]}> |
There was a problem hiding this comment.
Critical — Placeholder date still present
This was flagged in a prior review and is still unresolved. Every other changelog entry uses a real date.
| <Update label="MONTH DD, 2026" description="v2.37.0" tags={["CLI"]}> | |
| <Update label="August 18, 2026" description="v2.37.0" tags={["CLI"]}> |
Adjust to the actual release date.
Co-authored-by: claude[bot] <209825114+claude[bot]@users.noreply.github.com>
| rss: true | ||
| --- | ||
|
|
||
| <Update label="MONTH DD, 2026" description="v2.37.0" tags={["CLI"]}> |
There was a problem hiding this comment.
Critical — Placeholder date
"MONTH DD, 2026" is still a placeholder. Every other changelog entry uses a real date. This will render as-is on the live site.
| <Update label="MONTH DD, 2026" description="v2.37.0" tags={["CLI"]}> | |
| <Update label="August 18, 2026" description="v2.37.0" tags={["CLI"]}> |
Adjust the date to match the actual release date.
Co-authored-by: claude[bot] <209825114+claude[bot]@users.noreply.github.com>
2 participants
No description provided.