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

Correctly using the /# in docs url #821

Open
3 tasks
iam4tune opened this issue Sep 11, 2024 · 0 comments · May be fixed by #822
Open
3 tasks

Correctly using the /# in docs url #821

iam4tune opened this issue Sep 11, 2024 · 0 comments · May be fixed by #822
Labels
fix: bug Something isn't working
Milestone

Comments

@iam4tune
Copy link
Contributor

What happened?

While creating content for our documentations I have noticed the following with linking pages using the *.md/#.

  • The lint checker does not mark this as an error.
  • Pages referenced with *.md/# are inaccessible with the url link.
  • No errors are thrown, it runs fine during build with mkdocs build or mkdocs serve
  • It also works fine, when you try to access those links within the built HTML file.

What should happen instead?

We need to

  • Fix the url links in the docs with this issue
  • Add this to the url check to be done on the repo
  • Add this to the docs/contributing/contributor_guide.md

What browsers are you seeing the problem on?

No response

What devices are you seeing the problem on?

No response

@iam4tune iam4tune added the fix: bug Something isn't working label Sep 11, 2024
@iam4tune iam4tune linked a pull request Sep 11, 2024 that will close this issue
@wwarriner wwarriner added this to the Sprint 24-18 milestone Sep 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
fix: bug Something isn't working
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants