diff --git a/.docs/TSK-4-public-trust-desktop.png b/.docs/TSK-4-public-trust-desktop.png new file mode 100644 index 0000000..f2c7284 Binary files /dev/null and b/.docs/TSK-4-public-trust-desktop.png differ diff --git a/.docs/TSK-4-public-trust-mobile.png b/.docs/TSK-4-public-trust-mobile.png new file mode 100644 index 0000000..5415674 Binary files /dev/null and b/.docs/TSK-4-public-trust-mobile.png differ diff --git a/.tasks/2026-07-18-TSK-4-public-repository-trust-TASKS.md b/.tasks/2026-07-18-TSK-4-public-repository-trust-TASKS.md new file mode 100644 index 0000000..065a276 --- /dev/null +++ b/.tasks/2026-07-18-TSK-4-public-repository-trust-TASKS.md @@ -0,0 +1,24 @@ +# TSK-4 — Public Repository Trust + +**Overall status:** DONE + +## TG-001 — Public narrative and boundaries + +- **Owner:** Main agent +- **Status:** DONE +- **Acceptance:** README and root guidance explain the problem, evidence, limitations, contribution, security, and source terms. +- **Evidence:** Product-first README, real website screenshot, explicit available/unavailable table, `CONTRIBUTING.md`, `SECURITY.md`, and source-available `LICENSE` are present. + +## TG-002 — GitHub presentation + +- **Owner:** Main agent +- **Status:** DONE +- **Acceptance:** Description, homepage, topics, and landing-page repository language are accurate. +- **Evidence:** GitHub description, preview homepage, ten relevant topics, private vulnerability reporting, and protected `main` are configured. Landing copy now says design-partner research, price hypothesis, proposed workflow, and public build. + +## TG-003 — Validation + +- **Owner:** Main agent +- **Status:** DONE +- **Acceptance:** Links, checks, public rendering, and independent truthfulness review pass. +- **Evidence:** Full `bun run check` passes, Impeccable detector returns zero findings, desktop/mobile screenshots are inspected, and two isolated public-credibility reviews confirm the implemented boundary language. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..3f85884 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,15 @@ +# Contributing + +OpenAPI Studio is an evidence-gated founding build. Discuss substantial product work in an issue before implementation; unsolicited feature expansion may be declined when it is not supported by pilot evidence. + +## Before opening a pull request + +1. Read `AGENTS.md`, `PRODUCT.md`, `DESIGN.md`, and `specs/roadmap.md`. +2. Keep changes inside one small vertical slice. +3. Preserve truthful product boundaries—do not imply unfinished capabilities exist. +4. Do not include real API contracts, customer information, credentials, or generated secrets. +5. Run `bun run check`. + +Pull requests should explain the user problem, scope, validation evidence, and any security or privacy impact. Include screenshots for visual changes and link the relevant issue or feature specification. + +By submitting a contribution, you agree that the project owner may use, modify, and redistribute it as part of OpenAPI Studio. Opening a pull request does not change the repository’s source-available license. diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..e3ceef5 --- /dev/null +++ b/LICENSE @@ -0,0 +1,9 @@ +Copyright (c) 2026 Milon Biswas. All rights reserved. + +This repository is made publicly available for transparency and technical evaluation only. + +No permission is granted to copy, modify, distribute, sublicense, sell, host, or create derivative works from this software or its design assets without prior written permission from the copyright holder. + +Viewing or forking the repository through functionality provided by GitHub does not grant additional rights. Third-party dependencies and bundled font assets remain subject to their respective licenses. + +For licensing enquiries, contact pitechae@gmail.com. diff --git a/README.md b/README.md index 5245660..ee7a525 100644 --- a/README.md +++ b/README.md @@ -1,32 +1,66 @@ # OpenAPI Studio -Single-package modular monolith built with TanStack Start Solid for Cloudflare Workers. +Review consequential OpenAPI contract changes before they reach users. + +> **Founding build:** OpenAPI Studio is not a finished editor or self-serve product. The public repository currently proves the delivery foundation, demand test, and proposed review workflow. Product capabilities are built only after design-partner evidence. + +[![Quality](https://github.com/bymilon/openapi-studio-tanstack/actions/workflows/quality.yml/badge.svg)](https://github.com/bymilon/openapi-studio-tanstack/actions/workflows/quality.yml) + +![OpenAPI Studio demand-validation website](.docs/TSK-4-public-trust-desktop.png) + +_Website preview—not product UI._ + +[View the live preview](https://openapi-studio-tanstack-preview.pibin.workers.dev) · [Join design-partner research](mailto:pitechae@gmail.com?subject=OpenAPI%20Studio%20design-partner%20research) · [Read the product roadmap](specs/roadmap.md) + +## The problem + +Raw OpenAPI diffs show which lines moved, but teams still have to determine what may break, who is affected, and whether the new contract should be published. OpenAPI Studio is testing a focused workflow that keeps the change, consequence, and team decision connected. + +## What exists today + +| Area | Current evidence | +| ----------------------- | ---------------------------------------------------------------------------------------- | +| Design-partner research | Responsive landing page, qualified email path, explicit `$29/workspace/month` hypothesis | +| Delivery | Cloudflare Workers preview, locked Bun install, GitHub Actions validation | +| Quality | TypeScript, Oxlint, Oxfmt, Vitest, Playwright, axe accessibility checks | +| Data foundation | Drizzle schema, committed migration, local migration and database smoke checks | +| Operations | Request observability and identifier-free first-party conversion events | +| Product design | Labelled OpenAPI review prototype and evidence-gated roadmap | + +## What does not exist yet + +- No production OpenAPI editor or account access +- No contract import, validation, diff engine, revision history, or publishing workflow +- No customers, usage claims, testimonials, checkout, or billing +- No production deployment or custom domain + +The next product phase is intentionally gated on qualified conversations and pilot commitment. See [PRODUCT.md](PRODUCT.md), [DESIGN.md](DESIGN.md), and the [roadmap](specs/roadmap.md) for the decisions behind that boundary. + +## Architecture + +This is a single-package modular monolith using TanStack Start with Solid, TypeScript, Cloudflare Workers, Bun, Turso/libSQL, Drizzle ORM, Valibot, Tailwind CSS, Oxlint, Oxfmt, Vitest, and Playwright. Feature code lives under `src/features`; platform boundaries live under `src/platform`; migrations live under `drizzle`; browser and unit tests live under `tests` and adjacent feature files. ## Local development -Prerequisite: Bun 1.3.14 or a newer 1.x release. +Requires Bun 1.3.14 or a newer 1.x release. ```bash bun install --frozen-lockfile bun run dev ``` -## Validation +Run the same validation used by CI: ```bash bun run check ``` -Validate committed database migrations without cloud credentials: +Database access expects `TURSO_DATABASE_URL` and `TURSO_AUTH_TOKEN`. Copy `.env.example` to an ignored local environment file. Local development and CI do not require production credentials. `bun run deploy:preview` is human-gated; no production deployment command exists. -```bash -bun run db:check -bun run db:smoke -``` +## Contributing and security -Runtime database access expects `TURSO_DATABASE_URL` and `TURSO_AUTH_TOKEN`. Copy `.env.example` to an ignored local environment file; never commit real credentials. -`bun run db:integration` is reserved for an approved disposable Turso database. +Read [CONTRIBUTING.md](CONTRIBUTING.md) before proposing a change. Do not report vulnerabilities in public issues; follow [SECURITY.md](SECURITY.md). Never submit real API contracts, customer data, credentials, or confidential material. -`bun run deploy:preview` is intentionally human-gated and targets only the named Cloudflare preview environment. Local development and CI require no production credentials. No production deploy command exists in this phase. +## Source terms -Pull requests and pushes to `main` run the same locked install, application checks, and local migration smoke test in GitHub Actions. Remote Turso credentials are not available to untrusted pull-request jobs. +The repository is public for transparency and technical evaluation, but it is not currently open source. No reuse rights are granted. See [LICENSE](LICENSE). diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 0000000..b709b5e --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,17 @@ +# Security Policy + +## Reporting a vulnerability + +Do not open a public issue for suspected vulnerabilities. Email `pitechae@gmail.com` with the subject `OpenAPI Studio security report` and include: + +- The affected route, component, or commit +- Reproduction steps and expected impact +- Any suggested mitigation + +Do not access data that is not yours, degrade the service, or include credentials, customer data, or confidential API contracts in the report. Receipt will be acknowledged within three business days. No bug-bounty program is currently offered. + +Good-faith research that follows these boundaries will not be pursued or referred for legal action by the project owner. + +## Supported surface + +Only the latest commit on `main` and the named Cloudflare preview are in scope. OpenAPI Studio is a founding build without production accounts, editor access, or billing. Security claims beyond the implemented public surface are not implied. diff --git a/specs/features/2026-07-18-public-repository-trust/spec.md b/specs/features/2026-07-18-public-repository-trust/spec.md new file mode 100644 index 0000000..f2fb82f --- /dev/null +++ b/specs/features/2026-07-18-public-repository-trust/spec.md @@ -0,0 +1,23 @@ +# Public Repository Trust + +| Field | Value | +| ---------- | ---------------------------------------------------------------- | +| Feature ID | TSK-4 | +| Status | SPEC_APPROVED | +| Outcome | Make the public repository credible and truthful before outreach | + +## Requirements + +- **REQ-001:** Lead with the buyer problem and founding-build status, not the stack. +- **REQ-002:** Show current evidence and unavailable product capabilities separately. +- **REQ-003:** Link the live preview, pilot contact, roadmap, validation, and screenshot. +- **REQ-004:** State contribution, security-reporting, privacy, and source-use boundaries. +- **REQ-005:** Curate GitHub description, homepage, and topics. +- **REQ-006:** Landing-page repository links describe public build transparency, not finished-product proof. + +## Validation + +- README links and image resolve on GitHub. +- Repository metadata is populated and accurate. +- `bun run check` passes after copy and test changes. +- No product capability absent from the repository is presented as available. diff --git a/src/features/marketing/marketing-home.tsx b/src/features/marketing/marketing-home.tsx index 4014296..30e5c8c 100644 --- a/src/features/marketing/marketing-home.tsx +++ b/src/features/marketing/marketing-home.tsx @@ -12,7 +12,7 @@ Would we pay $29/workspace/month if this worked? Why or why not? Best, `.replaceAll('\n', '\r\n') -const applicationHref = `mailto:pitechae@gmail.com?subject=${encodeURIComponent('OpenAPI Studio founding pilot')}&body=${encodeURIComponent(applicationBody)}` +const applicationHref = `mailto:pitechae@gmail.com?subject=${encodeURIComponent('OpenAPI Studio design-partner research')}&body=${encodeURIComponent(applicationBody)}` const repositoryHref = 'https://github.com/bymilon/openapi-studio-tanstack' function Mark() { @@ -47,7 +47,7 @@ export function MarketingHome() { href={applicationHref} onClick={() => recordConversion('design_partner_clicked')} > - Join pilot + Join research @@ -55,12 +55,12 @@ export function MarketingHome() {

- Founding pilot Five teams + Design-partner research Five teams

Catch the breaking change before your users do.

- We are testing a workflow that turns an OpenAPI diff into a clear review of what - changed, what may break, and what the team should publish next. + We are testing whether small API teams need a clearer way to review OpenAPI contract + changes before we build the product workflow.

recordConversion('design_partner_clicked')} > - Email the founder about the pilot + Email the founder about the research See the workflow

- Free pilot now. $29/workspace/month only if it earns its place. + Interviews are free. A product pilot and $29/workspace/month price are hypotheses—not + available yet.

-

- Illustrative founding-pilot prototype · not a live editor -

+

Illustrative product concept · not a live editor

billing-api.yaml PR #184

@@ -139,8 +138,8 @@ export function MarketingHome() {
-

The workflow

-

From changed line to team decision.

+

Proposed workflow

+

The workflow we want to validate.

  1. @@ -171,18 +170,19 @@ export function MarketingHome() {
    -

    Evidence, not theatre

    -

    Inspect the work before you trust the promise.

    +

    Current build status

    +

    See what exists today—and what comes next.

    - OpenAPI Studio is an early founding pilot, not a finished self-serve product. The - public build targets OpenAPI 3.0/3.1, deploys to a Cloudflare preview, and records - identifier-free conversion events. No invented customers. No fake screenshots. No - checkout. + OpenAPI Studio is in demand validation, not a working editor. Today’s repository + contains this website, delivery checks, preview infrastructure, and identifier-free + conversion measurement. OpenAPI 3.0/3.1 import, validation, diff review, and + publishing are roadmap work—not implemented yet. No invented customers. No fake + screenshots. No checkout.

    recordConversion('repository_clicked')}> - Inspect public source ↗ + Follow the public build ↗
    -

    Five-team founding offer

    +

    Five-team research cohort

    Bring the contract change your team keeps paying for.

    $ 29

    - per workspace / month + price hypothesis
    - after a free pilot + product not available yet

    diff --git a/tests/browser/marketing.test.ts b/tests/browser/marketing.test.ts index 418522d..71419a0 100644 --- a/tests/browser/marketing.test.ts +++ b/tests/browser/marketing.test.ts @@ -18,11 +18,11 @@ test('presents a truthful design-partner conversion path', async ({ page }) => { }), ).toBeVisible() - const application = page.getByRole('link', { name: 'Email the founder about the pilot' }) + const application = page.getByRole('link', { name: 'Email the founder about the research' }) const applicationUrl = new URL((await application.getAttribute('href')) ?? '') expect(applicationUrl.protocol).toBe('mailto:') expect(applicationUrl.pathname).toBe('pitechae@gmail.com') - expect(applicationUrl.searchParams.get('subject')).toBe('OpenAPI Studio founding pilot') + expect(applicationUrl.searchParams.get('subject')).toBe('OpenAPI Studio design-partner research') expect(applicationUrl.searchParams.get('body')).toContain('Team and product:') expect(applicationUrl.searchParams.get('body')).toContain('Current OpenAPI workflow:') expect(applicationUrl.searchParams.get('body')).toContain( @@ -31,12 +31,11 @@ test('presents a truthful design-partner conversion path', async ({ page }) => { expect(applicationUrl.searchParams.get('body')).toContain( 'Would we pay $29/workspace/month if this worked? Why or why not?', ) - await expect( - page.getByText('No invented customers. No fake screenshots. No checkout.'), - ).toBeVisible() + await expect(page.getByText('not a working editor')).toBeVisible() + await expect(page.getByText('roadmap work—not implemented yet')).toBeVisible() await expect(page.getByText('Illustrative prototype—not a screenshot')).toBeVisible() await expect(page.getByText('no contract upload or confidential material')).toBeVisible() - await expect(page.getByRole('link', { name: 'Inspect public source' })).toHaveAttribute( + await expect(page.getByRole('link', { name: 'Follow the public build' })).toHaveAttribute( 'href', 'https://github.com/bymilon/openapi-studio-tanstack', ) @@ -54,7 +53,7 @@ test('has no detectable accessibility violations and a usable tab order', async await page.keyboard.press('Tab') await expect(page.getByRole('link', { name: 'Evidence' })).toBeFocused() await page.keyboard.press('Tab') - await expect(page.getByRole('link', { name: 'Join pilot' })).toBeFocused() + await expect(page.getByRole('link', { name: 'Join research' })).toBeFocused() }) test('keeps the offer usable on a narrow screen without JavaScript', async ({ browser }) => { @@ -67,8 +66,10 @@ test('keeps the offer usable on a narrow screen without JavaScript', async ({ br await page.goto('/') await expect(page.getByRole('main')).toBeVisible() - await expect(page.getByRole('link', { name: 'Email the founder about the pilot' })).toBeVisible() - await expect(page.getByText('per workspace / month')).toBeVisible() + await expect( + page.getByRole('link', { name: 'Email the founder about the research' }), + ).toBeVisible() + await expect(page.getByText('price hypothesis')).toBeVisible() expect((await page.locator('body').evaluate((body) => body.scrollWidth)) <= 360).toBe(true) await context.close()