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

Docs Module: Update Rendering Logic to Standardize URL Handling #22044

Open
salihozkara opened this issue Jan 29, 2025 · 0 comments · May be fixed by #22088
Open

Docs Module: Update Rendering Logic to Standardize URL Handling #22044

salihozkara opened this issue Jan 29, 2025 · 0 comments · May be fixed by #22088

Comments

@salihozkara
Copy link
Member

salihozkara commented Jan 29, 2025

To standardize URL structures across the documentation, changes should be implemented in the rendering logic rather than individual documentation files. This will ensure a consistent and maintainable solution.

  1. Rendering Logic Update:

    • Modify the code responsible for rendering navigation links to automatically handle /index paths.
    • Example: .../tutorials/module/index.md should now be printed to the page as .../tutorials/module instead of .../tutorials/module/index.
  2. Redirection:

    • Implement a 301 (permanent) redirect at the rendering level for URLs ending with /index to their parent directory equivalent (e.g., /module/index/module).

This change will simplify maintenance, improve URL aesthetics, and enhance the user experience.

https://github.com/volosoft/vs-internal/issues/5017

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants