Convert absolute internal doc links to relative .md paths - #80
Open
deboragracio wants to merge 4 commits into
Open
Convert absolute internal doc links to relative .md paths#80deboragracio wants to merge 4 commits into
deboragracio wants to merge 4 commits into
Conversation
Replace absolute links to our own documentation (docs.fiskaltrust.eu and docs.fiskaltrust.cloud) with relative paths to the corresponding .md files, so Docusaurus can resolve and validate them at build time. Broken links from moved pages or a domain change now surface as build failures instead of post-deploy 404s. - 60 links converted across 28 files, anchors preserved - Slug aliases resolved to their real files (e.g. germany -> middleware-de-kassensichv, france -> middleware-fr-boi-tva-decla-30-10-30, signing/austria -> signing-at-rksv) - release-notes and changelog links left absolute (separate repo, no local .md) Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
The "more details here" link for ARM support pointed at general/operation-modes#arm-processor, but the "ARM Processor" section (id: arm-processor) lives in general/components. The anchor was silently broken on the live site; with onBrokenAnchors: "throw" it would now fail the build. Repoint to the correct page. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
- integration-checklist.md: the "Reference tables" link pointed at the reference-tables *directory* without a filename (../../poscreators/middleware-doc/general/reference-tables#ftsignature). Point it at the actual file, matching the sibling links in the same table (../middleware-doc/general/reference-tables/reference-tables.md#ftsignature). - failure-scenario.md: remove a doubled slash in the path (reference-tables//reference-tables.md -> reference-tables/reference-tables.md). Both target files and anchors (#ftsignature, #ftreceiptcaseflag) verified. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Docusaurus does not generate an anchor id for a page's H1 (only h2-h6), so linking to #<title> is a broken anchor. Both links referenced the target page's own H1 title (redundant), so drop the fragment and link to the page: - single-receipt-creation.md -> type-of-receipt-ftreceiptcase.md (was #type-of-receipt-ftreceiptcase) - type-of-receipt-ftreceiptcase.md -> cash-register-integration-failure-scenarios.md (was #failure-scenarios) Fixes the "Docusaurus found broken anchors!" build failure. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
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.
What
Replaces absolute links to our own documentation (
docs.fiskaltrust.euanddocs.fiskaltrust.cloud) with relative paths to the corresponding.mdfiles, so Docusaurus can resolve and validate them at build time.Why
Absolute links bypass Docusaurus' build-time link validation. Broken links caused by moved/renamed pages or a domain change are only discovered after deployment (post-deploy 404s). Relative
.mdlinks are validated duringdocusaurus build(onBrokenLinks: "throw").Scope
.../middleware-doc/germany/data-structures→middleware-de-kassensichv/data-structures/data-structures.md.../middleware-doc/germany/dsfinv-k→middleware-de-kassensichv/procedural-documentation/dsfinv-k-generation.md.../middleware-doc/france/installation→middleware-fr-boi-tva-decla-30-10-30/installation/installation.md.../poscreators/signing/austria→middleware-doc/signing-at-rksv/rksv-sign-intro.md.../general/cash-register-integration→general/cash-register-integration/cash-register-integration-regular-workflow.md<a href>tag (FR appendix) rewritten as a Markdown link so Docusaurus resolves it.Left as absolute (intentional)
External links to a separate repo (
release-notes/changelog), which have no local.mdtarget:/docs/release-noteslinks/changelog/middleware/...linksVerification
.mdfile (repo-wide resolver: 0 broken).release-notes/changelogexternals).onBrokenAnchors: "throw").Pre-existing bug found & fixed
Validating anchors surfaced one silently-broken link: the "ARM usable with restrictions – more details here" link in
supported-environments.mdpointed atgeneral/operation-modes#arm-processor, but the ARM Processor section actually lives ingeneral/components. It was already broken on the live site; underonBrokenAnchors: "throw"it would fail the build. Repointed to the correct page (second commit).🤖 Generated with Claude Code