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

Add URL redirects for legacy /docs/* paths #1677

Merged
merged 2 commits into from
Oct 23, 2024

Conversation

sushmanthreddy
Copy link
Contributor

@sushmanthreddy sushmanthreddy commented Oct 23, 2024

Description

Added URL redirects to handle the legacy paths starting with /docs/* that were causing 404 errors for users. This fixes the broken links issue where users were trying to access URLs like docs/tutorials/rag instead of tutorials/rag.

Changes

  • Added mkdocs-redirects plugin configuration to handle legacy URL patterns
  • Implemented redirects for all tutorial pages:
    • /docs/tutorials/rag/tutorials/rag
    • /docs/tutorials/simplified-baleen/tutorials/simplified-baleen
    • /docs/tutorials/summarization/tutorials/summarization
    • /docs/tutorials/other_tutorial/tutorials/other_tutorial
    • /docs/tutorials/examples/tutorials/examples

Testing

  • Verified redirects work locally using mkdocs serve
  • Tested accessing old URLs to confirm proper redirection
  • Ensured existing URLs continue to work as expected

Dependencies

  • Requires mkdocs-redirects plugin: pip install mkdocs-redirects
Screenshot 2024-10-23 at 8 39 19 PM

@krypticmouse
Copy link
Collaborator

LGTM 🚢! Thank you for the contribution!!

@krypticmouse krypticmouse merged commit 8c67592 into stanfordnlp:main Oct 23, 2024
6 checks passed
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.

2 participants