Skip to content

Document approved external addons (gobl.fr.ctc) - #56

Draft
alvarolivie wants to merge 2 commits into
mainfrom
gbl-68-addon-converter-docs
Draft

Document approved external addons (gobl.fr.ctc)#56
alvarolivie wants to merge 2 commits into
mainfrom
gbl-68-addon-converter-docs

Conversation

@alvarolivie

Copy link
Copy Markdown
Contributor

Linear: GBL-68

With invopop/gobl#847, the French CTC addons move out of GOBL core into github.com/invopop/gobl.fr.ctc. Since this site generates addon pages from the runtime registry of the pinned gobl module, externalized addons would silently vanish from the docs on the next regeneration. This PR makes external addons first-class in the docs pipeline:

  • Import external addon modules in cmd/generate — their init() registers the addon defs, so the existing addon generator documents them exactly like bundled ones (extensions, scenarios, validation rules included).
  • Guard (phase 0): generation fails if any addon on gobl's approved external-addon list (tax.ApprovedAddons()) is missing from the runtime registry — the approved list in core acts as the manifest of external addons these docs must cover, so approving an addon without importing it here breaks the build instead of silently dropping pages.
  • Provenance callout: generated pages for external addons get an <Info> block linking the implementing module, and addons/overview.mdx gains an External Addons section explaining recognition vs. availability.
  • Regenerated against gobl@fr-ctc-extract + gobl.fr.ctc: adds fr-ctc-v1, fr-ctc-flow6-v1, fr-ctc-flow10-v1; refreshes fr-ctc-flow2-v1; draft-0 picks up the new bill lifecycle schemas (fault replaces condition).

Draft until the dependency chain completes

Pinned to pre-release pseudo-versions for now:

Once #847 merges and a core tag is cut, gobl.fr.ctc drops its dev replace and pins the tag; then this PR swaps both pseudo-versions for proper tags and regenerates.

Converters (gobl.ubl & co.) are deliberately out of scope — they'll be handled separately (docs site links/imports converter repos directly; no converter registry in core).

🤖 Generated with Claude Code

alvarolivie and others added 2 commits June 3, 2026 15:06
GOBL is moving addons out of core into standalone modules (invopop/gobl#847
extracts the French CTC addons to github.com/invopop/gobl.fr.ctc). Without
changes here, those addons would silently disappear from the docs on the next
regeneration.

- Import external addon modules in cmd/generate so their definitions register
  and the existing addon generator documents them like bundled ones.
- Guard: fail generation if an addon on gobl's approved external-addon list
  (tax.ApprovedAddons) is not loaded, so newly approved addons can't be
  forgotten here.
- Mark external addon pages with an Info callout linking the implementing
  module, and explain external addons in the overview.
- Regenerate from gobl@fr-ctc-extract + gobl.fr.ctc: adds fr-ctc-v1,
  fr-ctc-flow6-v1 and fr-ctc-flow10-v1 pages, refreshes fr-ctc-flow2-v1, and
  picks up the new bill lifecycle schemas (fault replaces condition).

Refs GBL-68.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
The previous commit lost the modified (tracked) files from its index;
this completes it: generator import+guard+callout, go.mod pins,
docs.json nav, overview section, and regenerated pages.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@mintlify

mintlify Bot commented Jun 3, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
gobl 🟢 Ready View Preview Jun 3, 2026, 3:13 PM

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