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

Enhanced Introduction, New Quick Start Section, Reorganized NPM Module Information, Improved Contributing Section #10312

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

A-n-sh
Copy link

@A-n-sh A-n-sh commented Feb 22, 2025

Description

This PR updates the Swagger UI README to improve clarity, organization, and usability. Changes include:

  • Enhanced Introduction with clearer overview
  • Added a Quick Start section for easy installation and setup
  • Reorganized NPM Module Information into a table for better readability
  • Improved Contributing Section with step-by-step instruction
  • Minor grammar and syntax improvements throughout the README

Motivation and Context

This change was made to enhance readability and usability of the Swagger UI README, making it easier for new users / contributors to quickly understand and setup the tool.

  • The introduction was unclear - now it concisely explains what Swagger UI does
  • Missing a Quick Start guide - now added for easy onboarding
  • Information about NPM modules was scattered - now formatted in a clear table
  • Contributing instructions were unclear - now structured with clear steps

How Has This Been Tested?

Screenshots (if appropriate):

  • Manually reviewed README rendering in a GitHub Markdown Preview
  • Checked links to ensure proper functionality
  • Verified formatting in Markdown preview tools

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.

FINAL NOTES
This PR is focused only on documentation improvements - no code changes were made
It improves user experience by making it easier to setup and contribute to Swagger UI

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.

1 participant