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

feat: change base url path to be / instead of /docs #165

Merged
merged 2 commits into from
Jan 27, 2025

Conversation

venkatamutyala
Copy link
Contributor

@venkatamutyala venkatamutyala commented Jan 26, 2025

PR Type

enhancement


Description

  • Changed the baseUrl configuration in docusaurus.config.js.

  • Updated the base URL path from /docs to /.


Changes walkthrough 📝

Relevant files
Configuration changes
docusaurus.config.js
Modify `baseUrl` configuration in Docusaurus                         

docusaurus.config.js

  • Updated the baseUrl configuration.
  • Changed the base URL path from /docs to /.
  • +1/-1     

    Need help?
  • Type /help how to ... in the comments thread for any questions about Qodo Merge usage.
  • Check out the documentation for more information.
  • Copy link

    PR Reviewer Guide 🔍

    Here are some key observations to aid the review process:

    ⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪
    🧪 No relevant tests
    🔒 No security concerns identified
    ⚡ Recommended focus areas for review

    URL Path Change

    Changing the base URL from '/docs' to '/' may affect all existing documentation links and routing. Verify that all internal links and navigation still work correctly after this change.

    baseUrl: "/",

    @venkatamutyala venkatamutyala changed the title feat: change base url path to be /docs feat: change base url path to be / instead of /docs Jan 26, 2025
    Copy link

    PR Code Suggestions ✨

    Explore these optional code suggestions:

    CategorySuggestion                                                                                                                                    Score
    Possible issue
    Add URL redirects for compatibility

    Changing the base URL from '/docs' to '/' might break existing documentation links
    and bookmarks. Consider implementing URL redirects from '/docs/' to '/' to
    maintain backward compatibility.

    docusaurus.config.js [20]

     baseUrl: "/",
    +routeBasePath: "/",
    +plugins: [
    +  {
    +    name: 'docusaurus-plugin-url-redirect',
    +    options: {
    +      redirects: [{from: '/docs/*', to: '/:splat'}]
    +    }
    +  }
    +],
    • Apply this suggestion
    Suggestion importance[1-10]: 9

    Why: This is a critical suggestion that addresses potential breaking changes in URL routing. The proposed redirect mechanism would prevent broken links and ensure a smooth transition for existing users after the baseUrl change.

    9

    @venkatamutyala
    Copy link
    Contributor Author

    @venkatamutyala need to fix commit message on merge

    @github-actions github-actions bot added the patch label Jan 26, 2025
    @venkatamutyala venkatamutyala merged commit 247e3d8 into main Jan 27, 2025
    6 checks passed
    @venkatamutyala venkatamutyala deleted the venkatamutyala-patch-1 branch January 27, 2025 04:15
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    2 participants