Skip to content

Fix typo error in README - #1954

Merged
ubogdan merged 1 commit into
swaggo:masterfrom
yashisrani:demo
Dec 28, 2024
Merged

ubogdan merged 1 commit into
swaggo:masterfrom
yashisrani:demo

Conversation

@yashisrani

@yashisrani yashisrani commented Dec 28, 2024 •

Copy link
Copy Markdown
Contributor

Fixed #1938

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:
  1. Updating the section title in the README from "Add response request" to "Add Request Headers" to align with the
    hyperlink.
  2. 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.

@ubogdan
ubogdan merged commit 94ff0fc into swaggo:master Dec 28, 2024
@ubogdan

ubogdan commented Dec 28, 2024

Copy link
Copy Markdown
Contributor

@yashisrani Thanks for your contribution.

@yashisrani yashisrani mentioned this pull request Jan 7, 2025
Thiht pushed a commit to Thiht/swag that referenced this pull request Feb 28, 2025
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.

Readme wrong link

2 participants

⌂ 换网址