Skip to content

Conversation

@sushmanthreddy
Copy link
Contributor

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 with the docs/ prefix instead of directly accessing the pages.

Changes

  • Added redirect configurations for all documentation sections in mkdocs.yml:
    • Quick Start:

      • /docs/quick-start/installation/quick-start/installation
      • /docs/quick-start/getting-started-01/quick-start/getting-started-01
      • /docs/quick-start/getting-started-02/quick-start/getting-started-02
    • Building Blocks:

      • /docs/building-blocks/solving_your_task/building-blocks/solving_your_task
      • /docs/building-blocks/1-language_models/building-blocks/1-language_models
      • /docs/building-blocks/2-signatures/building-blocks/2-signatures
      • (and similar for other building blocks files)
    • Deep Dive:

      • /docs/deep-dive/data-handling/*/deep-dive/data-handling/*
      • /docs/deep-dive/signature/*/deep-dive/signature/*
      • /docs/deep-dive/modules/*/deep-dive/modules/*
      • /docs/deep-dive/language_model_clients/*/deep-dive/language_model_clients/*
      • /docs/deep-dive/retrieval_models_clients/*/deep-dive/retrieval_models_clients/*
      • /docs/deep-dive/optimizers/*/deep-dive/optimizers/*
    • Main Pages:

      • /docs/faqs/faqs
      • /docs/cheatsheet/cheatsheet
      • /docs/dspy-usecases/dspy-usecases

Testing

  • Verified all redirects work locally using mkdocs serve
  • Tested accessing pages through old URLs to confirm proper redirection
  • Checked that existing direct URLs continue to work as expected
  • Validated redirect patterns match the current file structure
Screenshot 2024-10-24 at 12 36 56 AM

@krypticmouse
Copy link
Collaborator

LGTM 🚢

Thank you so much for the contribution!!!

@krypticmouse krypticmouse merged commit f8763e4 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