Add an agent primer, AGENTS.md and skill.md, and correct API docs against live behaviour - #585
Merged
Merged
Conversation
Coding agents are now a large share of the audience for these docs and kept tripping over GOBL basics before reaching Invopop concepts. This adds a dedicated primer and fixes the places where the docs disagreed with what the API actually does. New agent-facing files: - llms.mdx (/llms, replaces /api-ref/llms with a redirect): mental model, "GOBL in ten rules", "Invopop in ten rules", a seven-call curl loop, copyable prompts and URL routing tables. Every JSON example builds with the current gobl CLI. - AGENTS.md, published verbatim at docs.invopop.com/AGENTS.md as the condensed version integrators paste into their own agent instructions. - skill.md, overriding Mintlify's generated skill for `npx skills add`. - <Prompt> cards on nine pages (quickstart, GOBL, workflows, corrections, webhooks, authentication, white label, Peppol, VERI*FACTU). Docs corrected after running every claim against a live workspace: - Repeated PUTs and repeated POST keys return 409, even for identical bodies (idempotency page and agent files). - Jobs return 202 with a stub, or 200 with the full job when `wait` completes in time (job pages and transform spec, which listed 202 only). - Entry responses omit `signed` and `state` until set; the silo spec no longer says the envelope is returned only "when specifically requested". - Console `Empty` and `Invalid` labels are not values of `state`. - `correct` requires `type`; the spec example used the rejected `credit: true` form. - List endpoints need `limit` between 10 and 100 (to be relaxed by invopop/silo#242). - Series: Start Number maps to `start`, not `last_index`; the dead `last_index` and `last_entry_id` fields are removed from the spec and pages alongside invopop/api#125. - Cloudflare rejects Python urllib's default User-Agent (error 1010). Also: the gobl CLI now installs from github.com/invopop/gobl.dev, the home page links the primer, CLAUDE.md documents the agent-facing files and the <Prompt> idiom, and the unreferenced, non-building example.json is removed. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Automations to automatically generate PRs for you. |
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
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.
Why
Coding agents are now a large share of the audience for these docs, and they kept falling into the same traps: building GOBL documents by hand, guessing tax rate keys, misreading job responses, and never finding the right page. This PR gives them a dedicated entry point and, while verifying it, fixes the places where the existing docs disagreed with what the API actually does.
What's new
/llmsprimer (llms.mdx, in Get Started after Quickstart;/api-ref/llmsredirects here). Mental model with a diagram, "GOBL in ten rules", "Invopop in ten rules", a seven-call curl walkthrough, five copyable prompts, a "where to look" URL router and a vocabulary map. Every JSON example builds with gobl.dev v0.500.15 (core v0.504.0), and the "what build returns" block is byte-for-byte the CLI's output.AGENTS.mdat the repo root. Mintlify serves root Markdown verbatim (CLAUDE.mdis already live), so this publishes atdocs.invopop.com/AGENTS.mdas the condensed version integrators paste into their own agent instructions.skill.mdat the repo root, overriding Mintlify's auto-generated skill fornpx skills add https://docs.invopop.com.<Prompt>cards on nine pages: quickstart, GOBL overview, workflows, correct invoices, webhooks, authentication, white label, Peppol and VERI*FACTU invoicing. The idiom is documented inCLAUDE.mdand the country-guide skill.Docs corrected against the live API
Every claim on the new pages was run against a real workspace. Where existing pages disagreed with observed behaviour they were fixed too:
PUTs and repeatedPOSTkeys return 409 even for identical bodies (idempotency page).waitcompletes in time. The transform spec listed 202 only.signedandstateuntil set; the silo spec no longer claims the envelope comes back only "when specifically requested" (it is included on fetch, create, update and in lists).EmptyandInvalidlabels have no counterpart in the entrystatefield (states page).correctrequirestype; the spec example used the rejectedcredit: true.limitbetween 10 and 100 (being relaxed in invopop/silo#242; wording to revert once deployed).start, notlast_index. The deadlast_index/last_entry_idfields are removed from the spec and reference pages, matching invopop/api#125.github.com/invopop/gobl.dev(old path is gone; docs.gobl.org fixed in Point the CLI quick start at gobl.dev and drop the removed --draft flag gobl.docs#69).urllib's default User-Agent with403 error code: 1010.Removed
api-ref/llms.mdx(redirected to/llms).example.json, unreferenced and failing to build.Reviewer notes
mint broken-linkspasses;mint openapi-checkpasses for the silo, transform and sequence specs; pages were rendered locally withmint dev.skill.mdreplaces the generated skill. Deleting the file restores Mintlify's version if preferred.🤖 Generated with Claude Code