Skip to content

docs: use the generated function names in README and compile it in CI - #1

Merged
Loschcode merged 2 commits into
mainfrom
docs/readme-generated-methods
Oct 10, 2026
Merged

Loschcode merged 2 commits into
mainfrom
docs/readme-generated-methods

Conversation

@Loschcode

Copy link
Copy Markdown
Contributor

README called links_api::links_list (does not exist; it is links_service_list with required page_size and ten parameters) and pinned linkbreakers = "1.32.0". Examples now use links_service_create/links_service_list; scripts/check-docs.sh compiles every README Rust block as a temporary example, on PRs and in the release workflow. Generator gets real git ids (git_push.sh placeholders).

🤖 Generated with Claude Code

Loschcode and others added 2 commits October 10, 2026 22:37
The README called links_api::links_list, which does not exist (the function
is links_service_list, with page_size required and ten parameters after the
configuration), and pinned linkbreakers = "1.32.0". The README is kept across
regeneration, so nothing tied it to the generated code.

The examples now use links_service_create and links_service_list, and
scripts/check-docs.sh compiles every Rust block in the README as a temporary
example against the crate. It runs on pull requests and in the release
workflow before the commit and publish. The generator also gets the real git
ids, which replaces the GIT_USER_ID/GIT_REPO_ID placeholders in git_push.sh.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@chatgpt-codex-connector

Copy link
Copy Markdown

You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard.

@Loschcode
Loschcode merged commit 5e74090 into main Oct 10, 2026
1 check passed
@Loschcode
Loschcode deleted the docs/readme-generated-methods branch October 10, 2026 19:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant