Skip to content

Open source release preparation #26

@benSlaughter

Description

@benSlaughter

If we want other parents to self-host this, we need to make it welcoming.

Docs:

  • CONTRIBUTING.md — how to set up dev environment, run tests, submit PRs
  • Architecture guide — how games are structured, how to add a new game
  • Deployment guide — Docker, bare metal, Raspberry Pi
  • Screenshots/GIFs in README

Code:

  • Ensure no hardcoded paths or personal references
  • Environment variable documentation
  • Licence file (MIT or similar)

Community:

  • Issue templates (bug report, feature request, new game idea)
  • PR template
  • Code of Conduct
  • GitHub Discussions enabled

Marketing: Simple landing page or detailed README with screenshots showing the garden, games, and admin.

Metadata

Metadata

Assignees

No one assigned

    Labels

    devCode, infra, testing, performancelong-termScale & transform — 3-6 months

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions