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.

Sign up for GitHub

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

Jump to bottom

Fix typo error in README #1954

Merged

ubogdan merged 1 commit into swaggo:master from yashisrani:demo

Dec 28, 2024

Contributor

yashisrani commented Dec 28, 2024

Describe the PR

The link in the README file does not direct users to the correct section when clicked. Although the target section exists, it is incorrectly titled as "Add response request", which causes the link to fail. This issue disrupts navigation within the documentation.

Relation issue
e.g. https://github.com/swaggo/swag/pull/118/files

This Pull Request resolves the issue by:

Updating the section title in the README from "Add response request" to "Add Request Headers" to align with the
hyperlink.
Alternatively, modifying the hyperlink to match the existing section title if renaming the section is not suitable.

Additional context

The fix is a small but meaningful improvement to the overall documentation quality.


          Fix typo error in README

aeba77d

ubogdan approved these changes

View reviewed changes

ubogdan merged commit 94ff0fc into swaggo:master

10 checks passed

Contributor

ubogdan commented Dec 28, 2024

@yashisrani Thanks for your contribution.

yashisrani mentioned this pull request

Readme wrong link #1938

Open

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet