Skip to content

Introduce package capabilities with Sharpie and fix discovery links - #8

Merged
HarryCordewener merged 1 commit into
mainfrom
docs/sharpie-package-introduction
Oct 19, 2026
Merged

HarryCordewener merged 1 commit into
mainfrom
docs/sharpie-package-introduction

Conversation

@HarryCordewener

@HarryCordewener HarryCordewener commented Oct 19, 2026 •

Copy link
Copy Markdown
Member

The package README now leads with what a world can gain, a distinct Sharpie workbench illustration, and direct browse/install/author links. The install remote now names the actual SharpMUSH.Packages repository. The table adds HTTP Handler and Profile Handler and updates PF2e to 1.2.0, matching the current index and manifests.

Includes a separate 1280×640 package share card, editable HTML source and provenance. After merge, upload assets/branding/sharpie/marketing/social-preview.png in repository Settings → General → Social preview. This PR does not change that setting.

Validation: all eight package rows match index versions; local README links and art resolve; desktop/mobile renders without horizontal overflow; reviewed native alpha and anatomy; PNG export 174,755 bytes; git diff --check. No package manifests or softcode changed.

Examples below are local renders of the PR Markdown, not published GitHub screenshots.

Desktop package README example

Package share card

Summary by CodeRabbit

  • New Features

    • Added http-handler and profile-handler to the package catalog.
    • Updated pf2e-remaster to version 1.2.0.
    • Added a branded social preview for SharpMUSH Packages.
  • Documentation

    • Updated the README with a package-focused introduction, navigation links, and branding.
    • Added guidance for the social preview and related branding assets.

@coderabbitai

coderabbitai Bot commented Oct 19, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration
  • Configuration used: Organization UI
  • Review profile: ASSERTIVE
  • Plan: Essentials
  • Run ID: beec03c3-3537-4aa8-b077-2a6e7651f009
📥 Commits

Reviewing files that changed from the base of the PR and between 2af969d and 13ce7ac.

⛔ Files ignored due to path filters: 5
  • assets/branding/sharpie/marketing/examples/readme-1200.png is excluded by !**/*.png
  • assets/branding/sharpie/marketing/examples/readme-390.png is excluded by !**/*.png
  • assets/branding/sharpie/marketing/sharpie-package-hug.png is excluded by !**/*.png
  • assets/branding/sharpie/marketing/sharpie-package-workbench.png is excluded by !**/*.png
  • assets/branding/sharpie/marketing/social-preview.png is excluded by !**/*.png
📒 Files selected for processing: 5
  • README.md
  • assets/branding/sharpie/marketing/README.md
  • assets/branding/sharpie/marketing/share-card.html
  • assets/branding/sharpie/marketing/sharpie-package-hug.provenance.json
  • assets/branding/sharpie/marketing/sharpie-package-workbench.provenance.json

Included review availability: This review used your included allowance. 0 included reviews remain after this review. Your included PR review attempts over the past 7 days set your current allowance at 1 review per hour.

Walkthrough

The README now presents SharpMUSH Packages, updates repository links, and revises package catalog entries. New marketing files provide a branded social-preview page, asset instructions, and image provenance records.

Changes

Repository presentation

Layer / File(s) Summary
Package README
README.md
The opening description and navigation now focus on the package repository. Clone and dependency-source examples use the updated repository URL. The catalog adds http-handler and profile-handler, and updates pf2e-remaster to version 1.2.0.
Social preview assets
assets/branding/sharpie/marketing/*
A static HTML page defines the repository’s branded social preview. The marketing README documents asset requirements and activation steps. Two provenance records describe the corresponding images and their export details.

Priority: ⬇️ Low

Estimated code review effort: 2 (Simple) | ~10 minutes

Change: Other

Merge Risk: ⚪ Minimal · up to 13ce7

The package catalog and artwork links are consistent, and the older repository links redirect to the canonical location. No material issue remains to block merging.

Pre-merge checks: Passed 5
Check name Status Explanation
Description Check Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check Passed The title clearly summarizes the main changes: package capability updates, Sharpie branding, and corrected discovery links.
Docstring Coverage Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
Full details: Docstring Coverage

Explanation

No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (5 skipped: 5 unsupported.)

  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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

@HarryCordewener
HarryCordewener merged commit 03335aa into main Oct 19, 2026
3 checks passed
@HarryCordewener
HarryCordewener deleted the docs/sharpie-package-introduction branch October 19, 2026 04:49
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.

1 participant