Skip to content

Conversation

@rory-cd
Copy link

@rory-cd rory-cd commented Dec 17, 2025

Description

Adds a SplashKit NuGet package guide explaining updates from splashkit-core/PR#149.

Explains the following:

  • What NuGet is and what the SplashKit NuGet package does
  • How to build the package
  • How to test the package
  • How to add/update tests

Type of change

  • Documentation (update or new)

How Has This Been Tested?

Testing Checklist

  • Have run npm run format
  • Have run npm run build
  • Have run npm run dev and/or npm run preview, using:
    • Chrome
    • Safari
    • Firefox

Checklist

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have requested a review from ... on the Pull Request

@netlify
Copy link

netlify bot commented Dec 17, 2025

Deploy Preview for thoth-tech ready!

Name Link
🔨 Latest commit 7e29128
🔍 Latest deploy log https://app.netlify.com/projects/thoth-tech/deploys/695738e13822d50008f95b24
😎 Deploy Preview https://deploy-preview-158--thoth-tech.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@222448082Ashen
Copy link

222448082Ashen commented Dec 21, 2025

Peer Review - NuGet Package Guide

Thank 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

  • Clear Documentation: Well-organized with logical flow (Introduction → Building → Testing)
  • Component Usage: Great use of Starlight components (<Steps>, <FileTree>)
  • Code Examples: Well-formatted terminal commands and code snippets
  • Image Included: Screenshot renders correctly in deploy preview
  • Comprehensive Coverage: Covers building, testing, and extending tests

Recommended Improvements

1. Frontmatter Enhancement

The 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 Repository

Line 33 references SKM repository but the context is about splashkit-core. Consider clarifying:

  • Is this link correct? Should it point to the splashkit-core repo instead?
  • Current: [SKM](https://github.com/splashkit/skm.git)
  • Consider: [SplashKit Core](https://github.com/thoth-tech/splashkit-core) or verify correct source

3. Prerequisites Section

The 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-References

Line 98 mentions "SplashKit core integration tests" - consider adding a link if documentation exists for those tests.

Checklist Verification

Type of Change:

  • Documentation (new)

Content Quality:

  • Content is accurate and clear
  • Frontmatter present (could be enhanced)
  • Components used appropriately
  • Code syntax highlighting correct
  • Image renders properly

Testing:

Style Guidelines:

  • Follows Astro/Starlight patterns
  • Markdown formatting is consistent
  • Code blocks properly formatted

- 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
@rory-cd
Copy link
Author

rory-cd commented Jan 2, 2026

Thanks @222448082Ashen, the requested changes are addressed below:

  • Added description to frontmatter (order was not included - since the siblings don't include it, it defaults to order 1)
  • Moved .NET prerequisite to Introduction
  • Added a link to integration testing documentation

Line 33 references SKM repository but the context is about splashkit-core. Consider clarifying:
* Is this link correct? Should it point to the splashkit-core repo instead?

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)

  • Note added to Download the SplashKit native libraries section, explaining the absence of Linux native libraries
  • Added note explaining expected failure for graphics test on MSYS2/Windows

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.

2 participants