Skip to content

docs: complete JSDoc coverage for Stellar public API#27

Closed
JohnOluB wants to merge 1 commit into
wraith-protocol:mainfrom
JohnOluB:docs/stellar-jsdoc-coverage
Closed

docs: complete JSDoc coverage for Stellar public API#27
JohnOluB wants to merge 1 commit into
wraith-protocol:mainfrom
JohnOluB:docs/stellar-jsdoc-coverage

Conversation

@JohnOluB
Copy link
Copy Markdown

Closes #10
Adds full JSDoc to every public export from sdk/src/chains/stellar/. Every function has a 1–2 sentence summary, @param, @returns, @throws where applicable, a copy-pasteable @example block, and @see links to related functions. Types and interfaces have per-field documentation on all non-obvious fields. Constants carry semantic meaning beyond their literal values (e.g. the migration warning on STEALTH_SIGNING_MESSAGE).
Also sets up TypeDoc (typedoc.json + dev dependency) so npx typedoc generates clean reference HTML without errors — verifiable in the docs/stellar/ directory.
Checklist:

All public exports from sdk/src/chains/stellar have JSDoc matching the quality bar
npx typedoc generates clean reference HTML without errors
No TODO or FIXME in any new JSDoc
134/134 tests passing, build clean

@drips-wave
Copy link
Copy Markdown

drips-wave Bot commented May 27, 2026

@JohnOluB Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits.

You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀

Learn more about application limits

@truthixify
Copy link
Copy Markdown
Contributor

Closing as duplicate. Issue #10 was addressed in #14 which landed first. Sorry for the duplicated effort — that's on us for assignment-tracking visibility.

Would love to keep your engagement though. A couple of nearby open Stellar Wave issues that fit a JSDoc/docs-quality contributor well:

Pick anything that fits and ping me on the issue, I'll prioritize the review. Thanks @JohnOluB.

@truthixify truthixify closed this Jun 1, 2026
@JohnOluB
Copy link
Copy Markdown
Author

JohnOluB commented Jun 2, 2026

Closing as duplicate. Issue #10 was addressed in #14 which landed first. Sorry for the duplicated effort — that's on us for assignment-tracking visibility.

Would love to keep your engagement though. A couple of nearby open Stellar Wave issues that fit a JSDoc/docs-quality contributor well:

Pick anything that fits and ping me on the issue, I'll prioritize the review. Thanks @JohnOluB.

All three have been assigned

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.

Complete JSDoc coverage for Stellar public API

3 participants