Skip to content

docs: fix stale paths, branch name, boilerplate, and copyright holder#65

Merged
Aayam Bansal (aayambansal) merged 1 commit into
mainfrom
fix/repo-docs-hygiene
Jul 5, 2026
Merged

docs: fix stale paths, branch name, boilerplate, and copyright holder#65
Aayam Bansal (aayambansal) merged 1 commit into
mainfrom
fix/repo-docs-hygiene

Conversation

@aayambansal

Copy link
Copy Markdown
Member

Docs hygiene sweep across the repo, one small fix per issue:

  • Built-binary path: CONTRIBUTING now points at ./backend/cli/dist/@synsci/openscience-<platform>/bin/openscience, matching what build.ts actually emits (dist dirs are named from pkg.name).
  • Default branch: AGENTS.md said the default branch is dev; it is main.
  • frontend/docs README: replaced the unedited Starlight template (npm commands that don't resolve in this bun workspace) with a short real README: bun install at the repo root, bun run --cwd frontend/docs dev / build.
  • Consistency sweep: the help-wanted link now filters label:"help wanted" (the label has a space); NOTICE no longer points at the nonexistent THIRD_PARTY_LICENSES.md and its year is 2026; the ARCHITECTURE repo-layout block gains frontend/landing, tooling/util, and tooling/patches with the frontend rows re-aligned, and CONTRIBUTING's "Where things live" gains frontend/landing and tooling/launcher; AGENTS.md now points SDK regeneration at ./tooling/repo/generate.ts (run from the repo root) like CONTRIBUTING and ARCHITECTURE; the conventional-commit list includes ci:.
  • Copyright holder: the landing footer now reads "© {year} Synthetic Sciences. Apache 2.0.", agreeing with NOTICE.

Verified: bun run build passes in frontend/landing, and every path referenced in the edited docs exists.

Fixes #38
Fixes #39
Fixes #40
Fixes #41
Fixes #42

- Correct the built-binary path in CONTRIBUTING (#38)
- Point AGENTS.md at main as the default branch (#39)
- Replace the Starlight template README in frontend/docs (#40)
- Fix the help-wanted label filter, drop the dangling
  THIRD_PARTY_LICENSES.md pointer, bump the NOTICE year, complete the
  repo-layout listings, unify SDK-regen instructions on
  ./tooling/repo/generate.ts, and add ci to the commit-type list (#41)
- Align the landing footer with NOTICE on Synthetic Sciences (#42)
@vercel

vercel Bot commented Jul 5, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
openscience Ready Ready Preview, Comment Jul 5, 2026 11:21am

Request Review

@aayambansal Aayam Bansal (aayambansal) merged commit ffb0a41 into main Jul 5, 2026
9 checks passed
@aayambansal Aayam Bansal (aayambansal) deleted the fix/repo-docs-hygiene branch July 5, 2026 11:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment