Skip to content

Release: README, live demo, CI, screenshots, CONTRIBUTING, i18n #9

Description

@os-sam

Card docs/backlog/14-release.md · Milestone M4 · Blocked-by: #4, #6, #7, #8

The card that turns a working repository into something a stranger can try. Until it lands, the project is code; after it, it is a reference app.

Scope

README.md (bilingual, screenshots, a "try it" link), CONTRIBUTING.md, .github/workflows/ci.yml, docs/screenshots/, src/translations/ (en and zh-CN bundles for object, field and nav labels — load objectstack-i18n), docker-compose.yml + Dockerfile from the ObjectStack blank template, and the live-demo link recorded in the README.

Spec

  • CIpnpm install --frozen-lockfile && pnpm validate && pnpm lint && pnpm typecheck on push and PR. This repo has had no CI at all until now; every gate result so far has been a human pasting a terminal tail into a PR body.
  • i18n — 100 % label coverage for both locales (the i18n skill's coverage report), and an i18n block in defineStack with defaultLocale: 'en', supportedLocales: ['en', 'zh-CN'].
  • Screenshots — pipeline kanban, interview calendar, funnel dashboard, and the three apps' home views. These are the first thing anyone sees; take them against demo-en with the seed loaded, not against an empty database.
  • CONTRIBUTING — how to run the gates, the card workflow, DESIGN.md as architecture authority, and the no-vertical-vocabulary rule.

Acceptance

  • A fresh clone: pnpm install && pnpm dev boots with seed in under two minutes on a laptop.
  • CI green on main.
  • The README's first screen answers what this is and how to try it, without scrolling.

Out of scope

New features. Changes to DESIGN.md §01–§03.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions