hasura / ddn-docs

Repository for the Hasura DDN version of docs
https://hasura.io/docs
2 stars 6 forks source link

Adds trailing slash setup in docusaurus.config.ts #635

Closed seanparkross closed 1 month ago

seanparkross commented 1 month ago

Description 📝

Adds trailing slash setup in docusaurus.config.ts to try fix some unexpected behaviour.

Quick Links 🚀

nope

Assertion Tests 🤖

Adds trailing slash setup in docusaurus.config.ts to try fix some unexpected behaviour.

hasura-bot commented 1 month ago

Hey, @seanparkross :wave:

Thanks for this PR! Since you changed docs files, our automated Action assigned Sean as your reviewer :tada:

Before Sean looks over the changes, we ask you to take care of a couple of items:

The docs team aims to get all PRs reviewed within 48 hours of your team doing a review in the form of a content pass. Let Sean know the level of urgency on Slack :+1:

hasura-bot commented 1 month ago

DX: Assertion Testing

✅ Diff

The diff shows a clear and focused change that addresses a specific issue with the URL behavior. By explicitly enabling the 'trailingSlash' setting in the Docusaurus configuration, the expected behavior becomes more deterministic, potentially resolving issues with relative links and deployment environments.

✅ Integrated

In the context of the entire set of changes, enabling 'trailingSlash' in the configuration contributes positively to the overall usability of the documentation. It ensures consistency in URL formats across different environments. This can prevent 404 errors from broken links which is beneficial for users navigating the site, and it may also improve SEO as it helps search engines to index the site more effectively.

cloudflare-workers-and-pages[bot] commented 1 month ago

Deploying v3-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 6a31f22
Status: ✅  Deploy successful!
Preview URL: https://aab0d61a.v3-docs-eny.pages.dev
Branch Preview URL: https://sean-trailing-slash.v3-docs-eny.pages.dev

View logs