Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Dec 6, 2025

QueryableExtensions and other recently added utilities lacked documentation. Updated README and created detailed guides in /docs.

Changes

README.md

  • Added Documentation section with links to detailed guides
  • Reorganized utilities into Provider Interfaces, Services, Extension Methods, and Constants
  • Added inline examples for QueryableExtensions, EnumExtensions, IdentityExtensions, encryption services, DatabaseEnvironmentModelFactory, and Timezones
  • Fixed typo: IDirectory ProviderIDirectoryProvider

docs/ folder (new)

  • docs/README.md - Documentation index with navigation
  • docs/QueryableExtensions.md - WhereIf, OrderByIf, OrderByDescendingIf, GetPage, DistinctBy with real-world scenarios
  • docs/EnumExtensions.md - GetDisplayNameOrStringValue, GetDisplayName, HasDisplayName with UI integration examples
  • docs/EncryptionServices.md - Both AesEncryptionService and AesDerivedKeyEncryptionService with security best practices

Example Usage

// QueryableExtensions - conditional querying
var users = dbContext.Users
    .WhereIf(activeOnly, u => u.IsActive)
    .WhereIf(!string.IsNullOrEmpty(searchTerm), u => u.Name.Contains(searchTerm))
    .OrderByIf(sortByName, u => u.Name)
    .GetPage(pageNumber, pageSize)
    .ToList();

// EnumExtensions - display attributes
var displayName = Status.Active.GetDisplayNameOrStringValue(); // "Active User"

// IdentityExtensions - claims
var email = User.Identity.GetClaimValue(ClaimTypes.Email);
Original prompt

This section details on the original issue you should resolve

<issue_title>Update Readme Documentation</issue_title>
<issue_description>We have recently added QueryableExtensions to this project, and other additional methods.

Update the readme.md file, and add documentation to it, or any additional files linked to the /docs folder as needed to document this library.</issue_description>

Comments on the Issue (you are @copilot in this section)


💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

@coderabbitai
Copy link

coderabbitai bot commented Dec 6, 2025

Important

Review skipped

Bot user detected.

To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


Comment @coderabbitai help to get the list of available commands and usage tips.

…ns, and other utilities

Co-authored-by: mitchelsellers <5659113+mitchelsellers@users.noreply.github.com>
Copilot AI changed the title [WIP] Update readme documentation for QueryableExtensions Add comprehensive documentation for QueryableExtensions and library utilities Dec 6, 2025
Copilot AI requested a review from mitchelsellers December 6, 2025 06:27
@mitchelsellers mitchelsellers marked this pull request as ready for review December 6, 2025 06:41
@mitchelsellers mitchelsellers merged commit ac97add into develop Dec 6, 2025
3 checks passed
@mitchelsellers mitchelsellers deleted the copilot/update-readme-documentation branch December 6, 2025 06:41
@mitchelsellers mitchelsellers added the documentation Improvements or additions to documentation label Dec 6, 2025
@sonarqubecloud
Copy link

sonarqubecloud bot commented Dec 6, 2025

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

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Update Readme Documentation

2 participants