Strawly-Music/website
Strawly-Music/website
Watch
1
0
Fork
You've already forked website
 0
Code Issues Pull requests Activity

Shorten the README to what contributors need #1

Merged
GrumpyStraw merged 1 commit from shorter-readme into main 2026-10-22 19:04:25 +02:00
Conversation 0 Commits 1 Files changed 1 +7 -56
GrumpyStraw commented 2026-10-22 19:02:35 +02:00
Owner

The README listed every file, the release routine and the full screenshot commands. It now keeps what a contributor needs:

  • What the site is and how to preview it
  • The tools/update-sri.sh step after changing a script or the stylesheet, since browsers refuse a file whose hash does not match
  • Where the screenshots come from. The commands to take them are at the top of the scripts in tools/screenshots/

Checked

  • The README links and commands match the files in the repo
The README listed every file, the release routine and the full screenshot commands. It now keeps what a contributor needs: - What the site is and how to preview it - The `tools/update-sri.sh` step after changing a script or the stylesheet, since browsers refuse a file whose hash does not match - Where the screenshots come from. The commands to take them are at the top of the scripts in `tools/screenshots/` ## Checked - The README links and commands match the files in the repo
GrumpyStraw deleted branch shorter-readme 2026-10-22 19:04:25 +02:00
Sign in to join this conversation.
Reviewers
No reviewers
Labels
Clear labels
  
Kind/Bug
Something isn't working

  
Kind/Chore
Maintenance, refactor, tooling, or dependency work

  
Kind/Docs
Documentation only, no code change

  
Kind/Feature
New capability or module

  
Kind/Security
Vulnerability, hardening, or compliance-related

  
Priority
High
 Ahead of everything else in the backlog

  
Priority
Low
 Someday, not blocking anything

  
Reviewed
Duplicate
 Already tracked elsewhere

  
Reviewed
Invalid
 Not a real issue

  
Status
Blocked
 Waiting on something external before work can continue

  
Status
Needs-Decision
 Needs a product decision before it's ready to build

  
Status
Wontfix
 Deliberately not doing this

No labels
Kind/Bug
Kind/Chore
Kind/Docs
Kind/Feature
Kind/Security
Priority
High
Priority
Low
Reviewed
Duplicate
Reviewed
Invalid
Status
Blocked
Status
Needs-Decision
Status
Wontfix
Milestone
Clear milestone
No items
No milestone
Assignees
Clear assignees
No assignees
GrumpyStraw
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Reference
Strawly-Music/website!1
No description provided.