Skip to content

docs(readme): polish to the Corbits README standard - #10

Merged
TheGreatAxios merged 2 commits into
cl-9236-agent-token-move-drizzle-e2e-to-tests-and-add-wrong-tenantfrom
cl-9232-agent-token-make-readme-snippets-compile
Sep 27, 2026
Merged

TheGreatAxios merged 2 commits into
cl-9236-agent-token-move-drizzle-e2e-to-tests-and-add-wrong-tenantfrom
cl-9232-agent-token-make-readme-snippets-compile

Conversation

@TheGreatAxios

@TheGreatAxios TheGreatAxios commented Sep 25, 2026 •

Copy link
Copy Markdown
Contributor

Summary

  • The README opens with what the package is (inbound auth for agents calling back into their hub) and where it plugs into Interchange, then Quickstart, reference tables, Using with Interchange and Upgrading from 0.1.
  • Every snippet has imports, types against TenantEnv, and has no casts or ....
  • The grant sentence reads grammatically in the README and the mount's doc comment.
  • The schema column table is gone; the migrations section only says how to run them.
  • Development and migration rules move to CONTRIBUTING.md.
  • Stacked on test: move real-Postgres suites to e2e/ and drop helper unit tests #9.

Verification

  • README ts blocks extracted and run through tsc --noEmit --strict: pass
  • bun run typecheck, bun run build: pass; bun run test:e2e against local Postgres: 6 pass, 0 fail

Closes CL-9232
Closes CL-9233
Closes CL-9234
Closes CL-9235

@TheGreatAxios TheGreatAxios left a comment

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Self-review: diff matches the linked ticket(s); independent review passes addressed (fixed or waived as noted in the description); typecheck, build and the Postgres-backed suite pass on this branch.

@TheGreatAxios
TheGreatAxios force-pushed the cl-9232-agent-token-make-readme-snippets-compile branch from e41a8db to 9b4615a Compare September 25, 2026 18:09
@TheGreatAxios
TheGreatAxios force-pushed the cl-9232-agent-token-make-readme-snippets-compile branch from 9b4615a to 2b10cc1 Compare September 25, 2026 18:22
@TheGreatAxios
TheGreatAxios force-pushed the cl-9232-agent-token-make-readme-snippets-compile branch from 2b10cc1 to d2d71b5 Compare September 25, 2026 23:48
@TheGreatAxios
TheGreatAxios force-pushed the cl-9232-agent-token-make-readme-snippets-compile branch from d2d71b5 to 3f0c232 Compare September 25, 2026 23:49
@TheGreatAxios
TheGreatAxios force-pushed the cl-9232-agent-token-make-readme-snippets-compile branch from 3f0c232 to 21613fc Compare September 25, 2026 23:53
@TheGreatAxios TheGreatAxios changed the title Make the README snippets compile and say what the package is for Rewrite the README to the Corbits standard and add CONTRIBUTING.md Sep 25, 2026
@TheGreatAxios
TheGreatAxios force-pushed the cl-9232-agent-token-make-readme-snippets-compile branch 2 times, most recently from db86476 to c2f6bc9 Compare September 26, 2026 00:54
@TheGreatAxios TheGreatAxios changed the title Rewrite the README to the Corbits standard and add CONTRIBUTING.md docs(readme): polish to the Corbits README standard Sep 26, 2026
@TheGreatAxios
TheGreatAxios force-pushed the cl-9232-agent-token-make-readme-snippets-compile branch from c2f6bc9 to 40b1722 Compare September 26, 2026 01:27
@TheGreatAxios
TheGreatAxios force-pushed the cl-9232-agent-token-make-readme-snippets-compile branch from 40b1722 to 2d90f69 Compare September 26, 2026 01:37
@TheGreatAxios
TheGreatAxios added this pull request to stack #12 September 26, 2026 01:58
The opener names the use case, the grant sentence reads grammatically in
the README and the mount's doc comment, and the column table that
restated a private table definition is gone.
Opens with what the package is and where it plugs into Interchange, adds
a Quickstart, reference tables and upgrade notes for 0.1, and moves
development and migration rules to CONTRIBUTING.md.
@TheGreatAxios
TheGreatAxios force-pushed the cl-9232-agent-token-make-readme-snippets-compile branch from 2d90f69 to 9c3378c Compare September 27, 2026 01:00
@TheGreatAxios
TheGreatAxios removed this pull request from stack #12 September 27, 2026 01:42
@TheGreatAxios
TheGreatAxios added this pull request to stack #17 September 27, 2026 01:43
@TheGreatAxios
TheGreatAxios merged commit 64eda57 into main Sep 27, 2026
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