Skip to content

docs: Revise README content and improve package description and documentation#46

Merged
snovak7 merged 1 commit into
mainfrom
45-add-package-readmemd-docs
May 27, 2026
Merged

docs: Revise README content and improve package description and documentation#46
snovak7 merged 1 commit into
mainfrom
45-add-package-readmemd-docs

Conversation

@snovak7

@snovak7 snovak7 commented May 27, 2026

Copy link
Copy Markdown
Contributor

Closes #45

Summary by Sourcery

Revise and expand the package documentation for Escendit.Tools.Branding to clearly describe its behavior as a development-only branding tool and how it configures MSBuild properties and assets for consuming projects.

Documentation:

  • Rewrite the root README to better explain the package’s purpose, behavior, configuration options, scope, and requirements.
  • Add a package-level README under src/Escendit.Tools.Branding that documents default MSBuild properties, asset injection, override behavior, and licensing details.

@snovak7 snovak7 self-assigned this May 27, 2026
@snovak7 snovak7 linked an issue May 27, 2026 that may be closed by this pull request
@sourcery-ai

sourcery-ai Bot commented May 27, 2026

Copy link
Copy Markdown

Reviewer's Guide

Refines the NuGet package’s public documentation by expanding the root README with clearer behavior/usage details, adding sections on scope and requirements, and introducing a package-level README under src that mirrors and tailors the documentation for the published package view.

File-Level Changes

Change Details Files
Rewrite and expand root README to clarify package purpose, behavior, and usage details.
  • Updated package description to emphasize development-only behavior and automatic MSBuild branding/asset injection.
  • Replaced simple usage text with a structured "What It Does" section including a table of default MSBuild properties and explanations of injected assets.
  • Documented how to override default MSBuild properties and clarified MSBuild property precedence.
  • Added sections describing scope (development dependency behavior and build*/buildTransitive support) and requirements (.NET SDK and target frameworks).
  • Refined contributing and license sections for clearer instructions and updated link formatting.
README.md
Add a package-level README aligned with the root documentation for NuGet consumption.
  • Created a new README in the package project that summarizes the package’s purpose as a development-only branding tool.
  • Documented installation, default MSBuild properties, asset injection behavior, and override instructions specific to consuming projects.
  • Included notes on development dependency behavior and build/buildMultiTargeting/buildTransitive support.
  • Added a brief license note for the package README.
src/Escendit.Tools.Branding/README.md

Assessment against linked issues

Issue Objective Addressed Explanation
#45 Add a README.md file for the Escendit.Tools.Branding package that provides a brief description of the package.

Possibly linked issues


Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@coderabbitai

coderabbitai Bot commented May 27, 2026

Copy link
Copy Markdown

Warning

Review limit reached

@snovak7, we couldn't start this review because you've reached your PR review rate limit.

More reviews will be available in 22 minutes and 18 seconds. Learn how PR review limits work.

Your organization has run out of usage credits. Purchase more in the billing tab.

⌛ How to resolve this issue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans include higher PR review limits than trial, open-source, and free plans. In all cases, reviews become available again over time. During sustained high-volume PR review activity, CodeRabbit may temporarily slow when the next review becomes available.

Please see our Fair Usage Limits Policy for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: fd2f8278-d3c5-4433-b6e2-389a53d9255e

📥 Commits

Reviewing files that changed from the base of the PR and between 0f3226d and f2b364f.

📒 Files selected for processing (3)
  • README.md
  • src/Escendit.Tools.Branding/Escendit.Tools.Branding.csproj
  • src/Escendit.Tools.Branding/README.md
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch 45-add-package-readmemd-docs

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey - I've left some high level feedback:

  • The root README and the package README contain largely duplicated content; consider consolidating this into a single source (e.g., generate the package README from the root README or share a common fragment) to avoid future drift.
  • The Requirements section hardcodes .NET SDK 10.0.x and 10.0.102, which may become stale; consider phrasing this in terms of the global.json configuration or omitting the exact version to reduce future maintenance overhead.
Prompt for AI Agents
Please address the comments from this code review:

## Overall Comments
- The root README and the package README contain largely duplicated content; consider consolidating this into a single source (e.g., generate the package README from the root README or share a common fragment) to avoid future drift.
- The Requirements section hardcodes `.NET SDK 10.0.x` and `10.0.102`, which may become stale; consider phrasing this in terms of the `global.json` configuration or omitting the exact version to reduce future maintenance overhead.

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@kilo-code-bot

kilo-code-bot Bot commented May 27, 2026

Copy link
Copy Markdown

Code Review Summary

Status: No Issues Found | Recommendation: Merge

Files Reviewed (2 files)
  • README.md - documentation update
  • src/Escendit.Tools.Branding/Escendit.Tools.Branding.csproj - description and asset path
  • src/Escendit.Tools.Branding/README.md - new package README

Reviewed by laguna-m.1-20260312:free · 450,853 tokens

@snovak7 snovak7 merged commit c77312a into main May 27, 2026
8 checks passed
@snovak7 snovak7 deleted the 45-add-package-readmemd-docs branch May 27, 2026 19:45
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.

Add package README.md docs

1 participant