Skip to content

Fix: broken doc links#7024

Merged
sylvestre merged 2 commits intouutils:mainfrom
jovielarue:fix-broken-docs-links
Dec 31, 2024
Merged

Fix: broken doc links#7024
sylvestre merged 2 commits intouutils:mainfrom
jovielarue:fix-broken-docs-links

Conversation

@jovielarue
Copy link
Contributor

This PR fixes #6602.

This PR contains changes to fix the broken doc links as described in the issue above. On the contributing page, links to CODE_OF_CONDUCT.md and DEVELOPMENT.md were both broken.

The way I was able to fix this was to add the two files to the auto-created SUMMARY.md file with uudoc and add two files in the docs/src directory that reference the root directory's md files. SUMMARY shows mdbook which pages to put in the sidebar and generate HTML for, so this change adds Code of Conduct and Development links as suboptions under Contributing in the sidebar.

@github-actions
Copy link

GNU testsuite comparison:

Skip an intermittent issue tests/timeout/timeout (fails in this run but passes in the 'main' branch)

@jovielarue jovielarue force-pushed the fix-broken-docs-links branch from 3235adc to cd8bebe Compare December 30, 2024 15:45
@github-actions
Copy link

GNU testsuite comparison:

Skipping an intermittent issue tests/timeout/timeout (passes in this run but fails in the 'main' branch)

@sylvestre sylvestre merged commit 41ffffa into uutils:main Dec 31, 2024
@sylvestre
Copy link
Contributor

thanks

@jovielarue jovielarue deleted the fix-broken-docs-links branch January 1, 2025 21:33
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.

Broken Links in Documentation Website

2 participants