Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Ensure that local doc references inside documents also exist in the hierarchy.md #113

Open
codeallthethingz opened this issue Dec 13, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request triaged This issue or pull request was triaged

Comments

@codeallthethingz
Copy link
Contributor

codeallthethingz commented Dec 13, 2024

Your proposal or request for the feature

The github_readme_sync tool does check the following broken links:

  • Ensures the hierarchy.md references exist on the file system.
  • Ensures that references inside a document exist on the file system.

But it does not check (and should)

  • that references inside a document exist in the hierarchy.md

Alternatives

n/a

Additional context

This was brought to light when this PR was merged #87

and those missing links were then added in this PR #111

@codeallthethingz codeallthethingz added enhancement New feature or request documentation Improvements or additions to documentation triaged This issue or pull request was triaged labels Dec 13, 2024
@codeallthethingz codeallthethingz changed the title Tools: github_readme_sync tool should ensure that local doc references inside documents also exist in the hiearchy.md Ensure that local doc references inside documents also exist in the hierarchy.md Dec 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request triaged This issue or pull request was triaged
Projects
None yet
Development

No branches or pull requests

1 participant