Skip to content

docs(other): fix broken links and redirects#303

Open
JLekawa wants to merge 2 commits into
mainfrom
23232-docs-fix-links-in-website-broken-by-consolidating-navigation
Open

docs(other): fix broken links and redirects#303
JLekawa wants to merge 2 commits into
mainfrom
23232-docs-fix-links-in-website-broken-by-consolidating-navigation

Conversation

@JLekawa
Copy link
Copy Markdown
Contributor

@JLekawa JLekawa commented May 14, 2026

What/Why/How?

Fixes links broken by deleting navigation.md

Reference

Closes https://github.com/Redocly/redocly/issues/23232

Testing

Screenshots (optional)

Check yourself

  • Code is linted
  • Tested
  • All new/updated code is covered with tests

Security

  • Security impact of change has been considered
  • Code follows company security practices and guidelines

@JLekawa JLekawa requested a review from adamaltman May 14, 2026 14:14
Copy link
Copy Markdown

@redocly redocly Bot left a comment

Choose a reason for hiding this comment

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

marketing-site AI Review: 🟢 Completed

Reunite Bot has reviewed your changes and found 3 potential issue(s).

Note

Low Risk

This PR contains minor documentation and configuration updates to fix broken links and redirects. It does not introduce changes to the application code, so there is practically no risk of regression.

Overview

Updates broken navigation links caused by the deletion of navigation.md. Specifically, it replaces references to /docs/realm/navigation/navigation with /docs/realm/navigation in two migration guides (migrate-from-legacy-portal.md and migrate-api-reference.md) and updates two outdated redirect destinations in redirects.yaml.

Comment thread redirects.yaml Outdated
# Navigation redirects - Files moved to /navigation/
'/docs/realm/author/how-to/configure-nav':
to: '/docs/realm/navigation/navigation'
to: '/docs/realm/navigation/'
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

The redirect points to the consolidated '/docs/realm/navigation/' path, but 'navigation.md' still exists and is referenced in 'sidebars.yaml', 'config/breadcrumbs.md', and 'config/sidebar.md'. Ensure the file is deleted and all references are fully updated.

Comment thread redirects.yaml Outdated
# Navigation redirects - Files moved to /navigation/
'/docs/realm/author/how-to/configure-nav':
to: '/docs/realm/navigation/navigation'
to: '/docs/realm/navigation/'
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Since navigation.md is consolidated, consider adding a redirect from '/docs/realm/navigation/navigation' to '/docs/realm/navigation/'. This prevents 404 errors for users with bookmarks or external links pointing to the old page.

Comment thread docs-legacy/workflows/migrate-api-reference.md Outdated
Comment thread redirects.yaml Outdated
Comment thread redirects.yaml Outdated
Comment thread docs-legacy/developer-portal/migrate-from-legacy-portal.md Outdated
Co-authored-by: Adam Altman <adam@rebilly.com>
Comment thread redirects.yaml
to: '/docs/realm/navigation/multi-product'
'/docs/realm/author/how-to/configure-nav/navigation-buttons':
to: '/docs/realm/navigation/navigation'
to: '/docs/realm/navigation'
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

The redirect for '/docs/realm/author/how-to/configure-nav/navigation-buttons' should point to '/docs/realm/config/navigation' (where navigation buttons are actually configured) instead of the general '/docs/realm/navigation' page, to maintain the correct context.

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