Skip to content

Move OpenAPI and Arazzo urls#442

Merged
scharrier merged 4 commits intomainfrom
move-openapi-and-arazzo-urls
Mar 11, 2026
Merged

Move OpenAPI and Arazzo urls#442
scharrier merged 4 commits intomainfrom
move-openapi-and-arazzo-urls

Conversation

@scharrier
Copy link
Member

Let's enhance our urls, guides structure, and SEO. This PR:

  • moves spec guides to simpler URLs: https://docs.bump.sh/arazzo/v1.0/
  • add an introduction for each spec version: a simple page with a summary + most important links
  • updates all the internal links + adds redirections

@grossyoan can you double check the preview please?
@paulRbr can you have a look to the code changes + redirects?

Thanks! 🙏

@netlify
Copy link

netlify bot commented Mar 9, 2026

Deploy Preview for bump-content-hub ready!

Name Link
🔨 Latest commit eabbb5a
🔍 Latest deploy log https://app.netlify.com/projects/bump-content-hub/deploys/69b13adaadf87e0008c04bf5
😎 Deploy Preview https://deploy-preview-442--bump-content-hub.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@scharrier scharrier changed the title Move Openapi and Arazzo urls Move OpenAPI and Arazzo urls Mar 9, 2026
@scharrier scharrier requested review from grossyoan and paulRbr March 9, 2026 16:42
Copy link
Contributor

@grossyoan grossyoan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks Seb. I didn't find any issue.

I'm thinking that we'll have to change at least one link on the website: the one in the top navigation bar

Image

Copy link
Member

@paulRbr paulRbr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for this 👍

Migrate all specification files from _guides/openapi/specification/ and
_guides/arazzo/specification/ to a new _specifications/ Bridgetown
collection. This shortens URLs from /guides/openapi/specification/v3.x/
to /openapi/v3.x/ (and similarly for Arazzo). The new collection uses
permalink: /:path/ for clean URL generation.
Point navbar, sidebars, and all internal links to the new /openapi/
and /arazzo/ paths. Also add a Home link in specification sidebars
for easier navigation back to the main site.
Create index pages for OpenAPI v3.1, v3.2, and Arazzo v1.0 that
summarize each guide section and serve as entry points for readers.
These pages live at /openapi/v3.1/, /openapi/v3.2/, and /arazzo/v1.0/.
Set up 301 redirects from the old /guides/openapi/specification/ and
/guides/arazzo/specification/ paths to their new locations. This
ensures existing links and bookmarks continue to work.
@scharrier scharrier force-pushed the move-openapi-and-arazzo-urls branch from 3710e1c to eabbb5a Compare March 11, 2026 09:50
@scharrier scharrier merged commit 5352579 into main Mar 11, 2026
5 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.

3 participants