Source addons from gobl.dev bundle of external modules - #58
Merged
Conversation
Addons no longer all live in GOBL core: approved external addons (e.g. fr-ctc, sa-zatca) are implemented in their own Go modules, with the gobl.dev bundle package as the curated list of modules that ship. The generator now imports that bundle so the documented addon set tracks gobl.dev exactly, and upgrades gobl to v0.500.0. - Show the implementing Go module on each addon page, derived from tax.ApprovedAddons(). - Remove stale generated pages under addons/ and regimes/ (drops pl-favat-v2); only overview.mdx is hand-written. - Warn about approved addons with no registered definition (fr-ctc-v1 is a key-only placeholder today). - Rebuild the Addons > Definitions and Tax Regimes > Countries navigation groups in docs.json from the registered definitions instead of maintaining them by hand. - Regenerate all pages from gobl v0.500.0: adds fr-ctc-flow2/6/10, sa-zatca-v1 addons, NO and SA regimes, and the usual draft-0 schema churn. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Contributor
|
Docs PR opened: #59 Added a Changelog section with the first entry covering new addons, tax regimes, and document schemas shipped this week. |
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.
Summary
Addons no longer all live in GOBL core: approved external addons (fr-ctc flows, sa-zatca) are implemented in their own Go modules, with GOBL keeping a curated approved list (
tax.ApprovedAddons()) and gobl.dev'sbundlepackage declaring which external modules actually ship. This updates the docs generator to follow that model.Changes
cmd/generateblank-importsgithub.com/invopop/gobl.dev/bundle, so the documented addon set tracks gobl.dev exactly. To document a newly approved external addon,go get -u github.com/invopop/gobl.devand regenerate.fr-ctc-flow2-v1→gobl.fr.ctc), derived from the approved-addons list.addons/andregimes/that no longer correspond to a registered definition are deleted (dropspl-favat-v2); onlyoverview.mdxis hand-written.Addons → DefinitionsandTax Regimes → Countriesgroups indocs.jsonare now rebuilt by the generator (both had drifted out of date) alongside the existing Schemas (Draft 0) handling.fr-ctc-v1is approved but registers noAddonDef(key-only placeholder), so the generator warns instead of documenting it.fr-ctc-flow2/6/10-v1andsa-zatca-v1addon pages, NO and SA regimes, plus the expected draft-0 schema churn (bill/condition→bill/fault, neworg/endpoint,cbc/uri).addons/overview.mdxand the README explain the new multi-repo sourcing model.Test plan
go build ./...andgo vetcleanpl-favat-v2,bill/condition)mint broken-linkscould not run locally (CLI requires Node LTS, machine has Node 25) — worth a glance at the Mintlify preview🤖 Generated with Claude Code