-
Notifications
You must be signed in to change notification settings - Fork 69
Add SplashKit NuGet package guide #158
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
base: main
Are you sure you want to change the base?
Conversation
✅ Deploy Preview for thoth-tech ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Peer Review - NuGet Package GuideThank you for this comprehensive documentation! I've reviewed PR #158 following the SplashKit peer review guidelines. Overall, this is excellent work with clear structure and helpful content. Strengths
Recommended Improvements1. Frontmatter EnhancementThe frontmatter is minimal. Consider adding: ---
title: "NuGet Package Guide"
description: "Guide to building, testing, and distributing the SplashKit NuGet package for .NET"
sidebar:
order: 4
---This improves SEO and navigation clarity. 2. Link to External RepositoryLine 33 references SKM repository but the context is about
3. Prerequisites SectionThe note about .NET SDK appears at line 23-27. Consider moving prerequisites to the introduction or creating a dedicated "Prerequisites" section at the start for better visibility. 4. Cross-ReferencesLine 98 mentions "SplashKit core integration tests" - consider adding a link if documentation exists for those tests. Checklist VerificationType of Change:
Content Quality:
Testing:
Style Guidelines:
|
- Added description - Moved .NET prerequisite message to Introduction - Added link to integration test documentation - Added note explaining absence of Linux native libraries - Added note explaining expected failure for graphics test in MSYS2 environment
|
Thanks @222448082Ashen, the requested changes are addressed below:
This is correct, since SKM contains the latest stable libraries released to the public, while the splashkit-core repo does not track generated libraries. Additional changes from NuGet package PR (#149)
|
Description
Adds a SplashKit NuGet package guide explaining updates from splashkit-core/PR#149.
Explains the following:
Type of change
How Has This Been Tested?
Testing Checklist
npm run formatnpm run buildnpm run devand/ornpm run preview, using:Checklist