Skip to content

docs: Fix broken anchor links in README (mostly terraform)#85

Merged
kvendingoldo merged 1 commit into
tofuutils:mainfrom
Montana:docs/fix-readme-anchor-links
Jul 8, 2026
Merged

docs: Fix broken anchor links in README (mostly terraform)#85
kvendingoldo merged 1 commit into
tofuutils:mainfrom
Montana:docs/fix-readme-anchor-links

Conversation

@Montana

@Montana Montana commented Jul 7, 2026

Copy link
Copy Markdown

Hey all,

This fixes 10 broken internal anchor links in README.md. No content changes, only link targets.

When the hooks were renamed from terraform_* to tofu_* during the fork from pre-commit-terraform, the section headings in the README were updated but several links pointing to them were not. As a result, the "Hook notes" links in the "Available Hooks" table and one table-of-contents entry currently lead nowhere.

Changes

  • Updated 8 "Hook notes" links in the Available Hooks table to point to the
    existing #tofu_* headings instead of the old #terraform_* anchors:
    tofu_docs, tofu_docs_replace, tofu_docs_without_aggregate_type_defaults,
    tofu_fmt, tofu_providers_lock, tofu_tflint, tofu_tfsec, tofu_trivy,
    and tofu_wrapper_module_for_each
  • Fixed the TOC entry "Download OpenTofu modules from private GitHub repositories"
    (#download-tofu-modules-...#download-opentofu-modules-...) to match the
    actual heading slug

Verification

Checked every internal ](#...) link in the README against GitHub-generated heading anchors, zero broken links remain after this change.

@kvendingoldo

Copy link
Copy Markdown
Collaborator

lgtm! please, fix DCO, after that we'll merge it

Signed-off-by: Montana <montana@linux.com>
@Montana Montana force-pushed the docs/fix-readme-anchor-links branch from 456cdde to c2f6c57 Compare July 7, 2026 17:29
@Montana Montana changed the title docs: fix broken anchor links in README (mostly terraform) docs: Fix broken anchor links in README (mostly terraform) Jul 7, 2026
@Montana

Montana commented Jul 7, 2026

Copy link
Copy Markdown
Author

Hi @kvendingoldo,

Signed off on it and DCO is successful via:

git rebase HEAD~1 --signoff

Pushed with lease.

@kvendingoldo kvendingoldo merged commit 213d3c7 into tofuutils:main Jul 8, 2026
3 of 4 checks passed
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.

2 participants