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

Relative links in docs are not correct #4389

Closed
valentingregoire opened this issue Apr 5, 2024 · 10 comments
Closed

Relative links in docs are not correct #4389

valentingregoire opened this issue Apr 5, 2024 · 10 comments
Labels
documentation Improvements or additions to documentation

Comments

@valentingregoire
Copy link
Contributor

valentingregoire commented Apr 5, 2024

In some places in the docs, relative links to other pieces in the docs are incorrect:

It seems that all links that are in sub folder that pointing to a relative location yield a 404 (redirected to the 404 page).

Copy link

github-actions bot commented Apr 5, 2024

We found the following entries in the FAQ which you may find helpful:

Feel free to close this issue if you found an answer in the FAQ. Otherwise, please give us a little time to review.

This is an automated reply, generated by FAQtory

@davep davep added the documentation Improvements or additions to documentation label Apr 5, 2024
@davep
Copy link
Collaborator

davep commented Apr 5, 2024

It would be helpful to know how they're incorrect? What exactly are you seeing that is incorrect?

@valentingregoire
Copy link
Contributor Author

Fixed in: #4390

Also fixed typo bakcground to background.

@valentingregoire
Copy link
Contributor Author

It would be helpful to know how they're incorrect? What exactly are you seeing that is incorrect?

@davep, just click the links and you'll see. All relative links of documents inside a folder are impacted it seems.

@davep
Copy link
Collaborator

davep commented Apr 5, 2024

I clicked both the links before asking for clarification.

@valentingregoire
Copy link
Contributor Author

Updated to state that you get redirected to the 404 page.

@willmcgugan
Copy link
Collaborator

@davep The links @valentingregoire is referring to are in those pages, in the Syntax section. The links in the description are fine.

@valentingregoire
Copy link
Contributor Author

I have recreated the links in the description of this issue, just like they are displayed in the docs section where I am pointing at.

@davep
Copy link
Collaborator

davep commented Apr 5, 2024

in the Syntax section

Thanks @willmcgugan -- I'd initially clicked every possible link I could find before originally asking for clarification, but hadn't even registered that that was a link in the syntax section.

Copy link

github-actions bot commented Apr 6, 2024

Don't forget to star the repository!

Follow @textualizeio for Textual updates.

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
Projects
None yet
Development

No branches or pull requests

3 participants