Skip to content

docs: add public project handbook - #21

Merged
Codewriter90x merged 1 commit into
mainfrom
chore/public-wiki
Aug 19, 2026
Merged

docs: add public project handbook#21
Codewriter90x merged 1 commit into
mainfrom
chore/public-wiki

Conversation

@Codewriter90x

Copy link
Copy Markdown
Owner

Summary

Adds a public GitHub Wiki handbook for new users and contributors while keeping the repository documentation as the canonical technical reference.

Wiki

  • Getting Started
  • Features
  • Build from Source
  • Learning and Gameplay
  • MIDI and Device Setup
  • Local Songs
  • Platforms and Limitations
  • Troubleshooting
  • FAQ and Support
  • versioned sidebar and footer

The Wiki sources live under docs/wiki/ and are published with scripts/publish-github-wiki.sh.

Boundaries

  • source-only public distribution
  • no Unity binaries
  • no commercial audio, charts, artwork, or lyrics
  • macOS CoreMIDI support is documented without overstating other platforms

Validation

  • WIKI_CONTRACTS_OK pages=12
  • PUBLIC_READINESS_CONTRACTS_OK version=0.5.0 state=public
  • WEBSITE_LOCALIZATION_CONTRACTS_OK locales=it,en readme_lines=166
  • live Wiki publish verified and idempotent

@Codewriter90x
Codewriter90x marked this pull request as ready for review August 19, 2026 08:19
@Codewriter90x
Codewriter90x merged commit 43f5077 into main Aug 19, 2026
6 checks passed
@Codewriter90x
Codewriter90x deleted the chore/public-wiki branch August 19, 2026 08:19
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