Docs/agent skills - #7
Merged
Merged
Conversation
The generator is not the only way to get a unihttp client: unihttp ships `unihttp-client`, an agent skill that scaffolds the same kind of packaged, typed client from an OpenAPI spec or from a plain description of the API, plus a `unihttp` skill for idiomatic hand-written code. Neither was mentioned here. Add a short section linking to the repository and its Agent Skills section, with the plugin install commands and a note on which of the two paths to pick: the generator for determinism, regeneration, and specs larger than an agent's context; the skill when there is no machine-readable spec at all.
The README had grown past a screenful of top-level sections with no map at the top, and the agent-skills note landed at the very bottom — past Limitations, where nobody choosing how to get a client would look. Add a Table of Contents (h2 and h3, mirroring the style of unihttp's own README) and move the skills section directly under Quick start, so the two ways to get a client sit next to each other. Retitle it "Alternative: the unihttp agent skills" to read as a TOC entry. Also fix the `--check` cross-link in the CLI options table: GitHub slugifies "Checking the output — `--check`" to `checking-the-output----check`, with a hyphen for each space around the dropped em dash, so the two-hyphen anchor never resolved.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #7 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 30 30
Lines 2604 2604
=========================================
Hits 2604 2604 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The generator is not the only way to get a unihttp client: unihttp ships
unihttp-client, an agent skill that scaffolds the same kind of packaged, typed client from an OpenAPI spec or from a plain description of the API, plus aunihttpskill for idiomatic hand-written code. Neither was mentioned here.Add a short section linking to the repository and its Agent Skills section, with the plugin install commands and a note on which of the two paths to pick: the generator for determinism, regeneration, and specs larger than an agent's context; the skill when there is no machine-readable spec at all.
Description
Please include a summary of the change and specify which issue is being addressed. Additionally, provide relevant motivation and context.
Fixes # (issue number)
Type of change
Please delete options that are not relevant.
Checklist
uv run ruff checkanduv run ruff format --checkshow no errors)uv run mypy