Merged
Conversation
teociaps
added
documentation
- Removed "classic" and "modern" styles in favor of just one single style. - Introduced `standalone.style.css` for independent themes without dependencies on `common.css` or `ui.js`. - Enhanced maintainability by restructuring CSS files and removing unused styles.
- Removed "modern." prefixes from CSS/JS filenames for simplicity. - Consolidated `Style` and `ModernStyle` into a single `Theme` class. - Renamed all "Style" references to "Theme" across the codebase. - Added support for standalone themes (no `common.css` or `ui.js`). - Updated `FileProvider.cs` to handle themes and standalone logic. - Refactored `SwaggerUIBuilderExtensions` and `NSwagBuilderExtensions`. - Updated tests, samples, and documentation to reflect changes. - Removed classic styles and related logic (breaking change).
Revised README.md and package-readme.md to improve clarity, structure, and visual appeal. Added new sections for quick start, features, and breaking changes. Updated badges, links, and examples for Swashbuckle and NSwag. Adjusted NuGet.props to fix `PackagePath` for `package-readme.md`. Updated readme.txt with detailed release notes for v3.0.0, highlighting breaking changes, .NET 10 support, and other improvements. Enhanced user guidance with links to migration guides and documentation.
…re in project files
teociaps
force-pushed
the
styles-refactoring
branch
from
60845c3 to
4941b11
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request introduces several improvements and cleanups across documentation, sample projects, and theme customization to streamline usage and clarify the project's structure. The most significant updates include a major rewrite of the
README.mdfor better onboarding, consolidation and modernization of sample theme code, and adjustments to package metadata for NuGet publishing.Documentation and onboarding improvements:
README.mdto provide a clearer, more inviting introduction, quick start guide, feature overview, usage examples, package table, and links to documentation and migration guides.CONTRIBUTING.mdto clarify that style/script guidelines apply specifically to theme files.package-readme.mdcontent, as information is now covered in the main documentation.Sample project and theme structure modernization:
CustomThemeclass (inheriting fromTheme) instead of separateStyle/ModernStylesubclasses, simplifying theme customization and usage. [1] [2]custom.cssandstandalone.custom.cssfiles, and removed obsolete files and code. [1] [2] [3] [4] [5] [6]Packaging and NuGet publishing:
build/NuGet.propsto ensurepackage-readme.mdis included in the root of the package, improving NuGet package presentation.These changes make the project easier to adopt, modernize theme extension, and improve the clarity and maintainability of both the codebase and documentation.