Skip to content

Rename README.md files in file tree to index.md#447

Open
BoHristova wants to merge 1 commit intogardener:masterfrom
BoHristova:rename-readme-files-in-file-tree
Open

Rename README.md files in file tree to index.md#447
BoHristova wants to merge 1 commit intogardener:masterfrom
BoHristova:rename-readme-files-in-file-tree

Conversation

@BoHristova
Copy link

Why do we need the PR:
README.md files in the file tree retain their file name. When anchor links are resolved, README.md is converted to readme and inserted before the anchor, which breaks the link (e.g., https://gardener.cloud/docs/proposals/0001-gardener-extensibility/readme/#table-of-contents). As a result, all table-of-contents links in the Proposals section on gardener.cloud are broken (see gardener/documentation#857).

What does the PR do:
Updates manifest.go so that README.md files in the file tree are renamed to index.md.

Which issue(s) this PR fixes:
Fixes gardener/documentation#857

Special notes for your reviewer:

Release note:

NONE

@gardener-prow
Copy link

gardener-prow bot commented Feb 27, 2026

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign dimitar-kostadinov for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@gardener-prow gardener-prow bot added do-not-merge/needs-kind Indicates a PR lacks a `kind/foo` label and requires one. cla: yes Indicates the PR's author has signed the cla-assistant.io CLA. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Feb 27, 2026
@BoHristova BoHristova added the kind/enhancement Enhancement, improvement, extension label Feb 27, 2026
@gardener-prow gardener-prow bot removed the do-not-merge/needs-kind Indicates a PR lacks a `kind/foo` label and requires one. label Feb 27, 2026
@BoHristova BoHristova requested a review from Kostov6 February 27, 2026 09:08
Copy link
Member

@marc1404 marc1404 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Have you tested this change with a development build of docforge in the documentation? It's difficult to judge the implications for all the places where README.md files are being pulled in.

So far, I haven't understood why Docforge turns relative anchor links into absolute links. Or more specifically, relative links that only refer to the same document, such as:
https://github.com/gardener/enhancements/blob/a9de75723e93627fd2eb8ae80bd3f1be29e3f9ff/geps/0001-gardener-extensibility/README.md#L5

- [GEP-0001: Gardener Extensibility and Extraction of Cloud-Specific/OS-Specific Knowledge (#308, #262)](#gep-0001-gardener-extensibility-and-extraction-of-cloud-specificos-specific-knowledge-308-262)

The easiest solution would be to keep these in-document anchor links exactly as given.

@BoHristova
Copy link
Author

Have you tested this change with a development build of docforge in the documentation? It's difficult to judge the implications for all the places where README.md files are being pulled in.

Yes, I tested it with a development build of docforge in the Gardener documentation. But I understand your concerns, and I'm open to suggestions on how to fix the problem in a more straighforward way :)

@Kostov6 Kostov6 self-assigned this Mar 9, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cla: yes Indicates the PR's author has signed the cla-assistant.io CLA. kind/enhancement Enhancement, improvement, extension size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Broken anchor links in "Proposals" section

3 participants