docs(api): document public API + JSR publish workflow (score -> 100) - #862
Merged
Conversation
Raises the JSR score toward 100 by covering the remaining checks: - Module doc + `@example` on the `mod.ts` entrypoint, plus a package README (readme/module-doc, examples, module-docs-in-all-entrypoints). - JSDoc on every exported symbol (schemas, inferred model types, contracts, factories, client helpers) - 100% symbol coverage, up from 0%. The comments are carried into the generated declarations, so JSR sees them. - GitHub Actions workflow that publishes to JSR via OIDC, which records provenance (public transparency log entry) on the next release.
0.5.0 was already published (static types only); 0.5.1 is the first version to ship the docs and JSR publish workflow. Published versions are immutable, so a new version is required to update the JSR score.
Adds trakt-web-style agent rules: root CLAUDE.md routes to .agents/rules/, AGENTS.md loads the core project rule, and domain rules cover keeping the @trakt/api JSR score at 100 (jsr.md) and authoring contract schemas (schemas.md, migrated from the previous AGENTS.md).
Contributor
Author
|
Added agent rules (trakt-web style) to keep the score from regressing:
Not published (outside |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Follow-up to #861 (static types, merged). Closes out the remaining JSR score checks to reach 100.
Changes
@exampleon themod.tsentrypoint, plus a package README - covers readme/module-doc, examples, and module-docs-in-all-entrypoints.traktApi,traktApiFactory,TraktApi,AbortError,Environment, ...) are hand-written. Comments are carried into the generated declarations, so JSR counts them..github/workflows/publish.yml) that publishes via GitHub OIDC, which records provenance (public transparency log entry) on the next release. Runsdeno task build:typesbefore publishing.JSR checklist
Verified
deno docsymbol coverage: 100% (414/414)@exampledetected on the entrypointdeno lint,deno check src,deno task openapi:validate,deno task publish:checkall cleanNotes