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

fix(docs): markdown links #9878

Closed
wants to merge 1 commit into from

Conversation

remscodes
Copy link

Description

Fix broken links in docs.

Checklist

My PR contains...

  • No code changes (src/ is unmodified: changes to documentation, CI, metadata, etc.)
  • Dependency changes (any modification to dependencies in package.json)
  • Bug fixes (non-breaking change which fixes an issue)
  • Improvements (misc. changes to existing features)
  • Features (non-breaking change which adds functionality)

My changes...

  • are breaking changes to a public API (config options, System API, major UI change, etc).
  • are breaking changes to a private API (Redux, component props, utility functions, etc.).
  • are breaking changes to a developer API (npm script behavior changes, new dev system dependencies, etc).
  • are not breaking changes.

Documentation

  • My changes do not require a change to the project documentation.
  • My changes require a change to the project documentation.
  • If yes to above: I have updated the documentation accordingly.

Automated tests

  • My changes can not or do not need to be tested.
  • My changes can and should be tested by unit and/or integration tests.
  • If yes to above: I have added tests to cover my changes.
  • If yes to above: I have taken care to cover edge cases in my tests.
  • All new and existing tests passed.

@char0n
Copy link
Member

char0n commented Apr 30, 2024

All the changes are just incorrect. Not sure what this PR is about

@remscodes
Copy link
Author

At https://swagger.io/docs/open-source-tools/swagger-ui/usage/configuration/#display, in the description section of deepLinking, the link Deep Linking documentation is 404.

My changes was about to fix it, and fix other links that point to the raw markdowns in the repository instead of the website pages.

Maybe the changes are incorrect, but the issues exist.

@char0n
Copy link
Member

char0n commented May 7, 2024

Hi @remscodes,

Thanks for additional context. I get it now.

But we cannot change links here, as it would break SwaggerUI Docs when viewed on GitHub. Could you open an issue on https://github.com/swagger-api/swagger.io/issues ?

Thanks!

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.

None yet

2 participants