Skip to content

docs(readme): rewrite around what an artifact is and how to boot it - #25

Open
TheGreatAxios wants to merge 2 commits into
mainfrom
cl-9092-artifacts-fix-readme-passing-createartifactdb-result-to
Open

TheGreatAxios wants to merge 2 commits into
mainfrom
cl-9092-artifacts-fix-readme-passing-createartifactdb-result-to

Conversation

@TheGreatAxios

@TheGreatAxios TheGreatAxios commented Sep 25, 2026 •

Copy link
Copy Markdown
Contributor

Summary

  • README opens with one sentence saying what an artifact is, installs with a single npm add line, and shows the boot sequence with createArtifactDb's { db, close } destructured and close() on shutdown.
  • The false "Runtime support" section (there is no bun export condition) and the "How it works" section that restated the mount sections are gone.
  • Every mountArtifacts / mountWorkflowArtifacts option, including onArtifactCreated, decorate, uploadPolicy, maxBinaryBytes and maxContentChars, has a row in the README reference tables with its default.
  • The sidecar section says plainly that the host binds the agent's hub credential to its hub token and that the run-scoped routes live at /api/workflow-artifacts.
  • Contributor setup and the internals write-up (formerly ARCHITECTURE.md) live in CONTRIBUTING.md. SECURITY.md moves to .github/, where GitHub still surfaces it as the security policy.
  • The hub-credential sentence matches the wording on HUB_CREDENTIAL_HANDLE in src/sidecar-bundle.ts.
  • First PR of the stack docs(readme): rewrite around what an artifact is and how to boot it #25 → fix(uploads): store upload bytes per version #31, based on main.

Verification

  • Docs only, plus one comment in src/schema.ts. bun run typecheck is clean.
  • The boot snippet and option defaults were checked against src/db.ts, src/migrations.ts, src/mount.ts and src/workflow-mount.ts.
  • No references to ARCHITECTURE.md or the root SECURITY.md remain.

Closes CL-9092
Closes CL-9096
Closes CL-9097
Closes CL-9101
Closes CL-9108
Closes CL-9111
Closes CL-9113
Closes CL-9129

@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.

Reviewed the whole branch against the code. The boot snippet matches createArtifactDb ({ db, close }) and runArtifactMigrations(db, options?). The option rows and their defaults match src/mount.ts and src/workflow-mount.ts, and the /api/workflow-artifacts path matches WORKFLOW_ARTIFACTS_BASE_PATH. Apart from the renamed Migration runner heading and the dropped options table, which the README tables now replace, the internals text moved into CONTRIBUTING.md unchanged. No stale ARCHITECTURE.md references remain. Each commit's message matches its diff. No blocking findings.

Open with a plain definition, collapse the install block to npm, and
show the migration boot with createArtifactDb's { db, close } result
destructured, since passing the whole object did not typecheck. Drop
the Runtime support section (no bun export condition exists) and the
How it works section that restated the mount sections. Spell out every
mount option in the reference tables instead of deferring to
ARCHITECTURE.md, and say plainly that the host binds the agent's hub
credential. Contributor setup moves to CONTRIBUTING.md.
The internals write-up moves from ARCHITECTURE.md into CONTRIBUTING.md,
so the repo root carries only README and CONTRIBUTING like other
Corbits packages. SECURITY.md moves to .github/, where GitHub still
surfaces it as the security policy.
@TheGreatAxios
TheGreatAxios force-pushed the cl-9092-artifacts-fix-readme-passing-createartifactdb-result-to branch from cc8ba8f to 75e8ad1 Compare September 26, 2026 01:29
@TheGreatAxios TheGreatAxios changed the title Rewrite README around what an artifact is and fold root docs into CONTRIBUTING docs(readme): rewrite around what an artifact is and how to boot it Sep 26, 2026
@TheGreatAxios
TheGreatAxios added this pull request to stack #32 September 26, 2026 01:57
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