Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Document @solana/compat with TypeDoc #65

Merged
merged 1 commit into from
Jan 29, 2025
Merged

Document @solana/compat with TypeDoc #65

merged 1 commit into from
Jan 29, 2025

Conversation

steveluscher
Copy link
Collaborator

This PR moves content from the README into the code.

Addresses #50

Test Plan

cd packages/compat
pnpm typedoc --watch \
  --plugin typedoc-plugin-missing-exports \
  --plugin typedoc-plugin-mdn-links
python3 -m http.server -d docs

Preview here: https://venerable-rabanadas-d6ba99.netlify.app/

@changeset-bot changeset-bot
Copy link

changeset-bot bot commented Jan 16, 2025

⚠️ No Changeset found

Latest commit: ebe8506

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@steveluscher Graphite App
Copy link
Collaborator Author

This stack of pull requests is managed by Graphite. Learn more about stacking.

@bundlemon BundleMon
Copy link

bundlemon bot commented Jan 16, 2025

BundleMon

Unchanged files (127)
Status Path Size Limits
✅ @solana/web3.js production bundle
library/dist/index.production.min.js
 33.84KB -
✅ rpc-graphql/dist/index.browser.mjs
 18.76KB -
✅ rpc-graphql/dist/index.native.mjs
 18.75KB -
✅ rpc-graphql/dist/index.node.mjs
 18.75KB -
✅ errors/dist/index.node.mjs
 14.06KB -
✅ errors/dist/index.browser.mjs
 14.04KB -
✅ errors/dist/index.native.mjs
 14.03KB -
✅ transaction-messages/dist/index.browser.mjs
 7.05KB -
✅ transaction-messages/dist/index.native.mjs
 7.05KB -
✅ transaction-messages/dist/index.node.mjs
 7.05KB -
✅ codecs-data-structures/dist/index.native.mjs
 4.77KB -
✅ codecs-data-structures/dist/index.browser.mjs
 4.77KB -
✅ codecs-data-structures/dist/index.node.mjs
 4.77KB -
✅ webcrypto-ed25519-polyfill/dist/index.node.mj
s
 3.57KB -
✅ webcrypto-ed25519-polyfill/dist/index.browser
.mjs
 3.56KB -
✅ webcrypto-ed25519-polyfill/dist/index.native.
mjs
 3.54KB -
✅ rpc-subscriptions/dist/index.browser.mjs
 3.38KB -
✅ rpc-subscriptions/dist/index.node.mjs
 3.34KB -
✅ rpc-subscriptions/dist/index.native.mjs
 3.31KB -
✅ codecs-core/dist/index.browser.mjs
 3.3KB -
✅ codecs-core/dist/index.native.mjs
 3.3KB -
✅ codecs-core/dist/index.node.mjs
 3.3KB -
✅ rpc-transformers/dist/index.browser.mjs
 2.92KB -
✅ rpc-transformers/dist/index.native.mjs
 2.92KB -
✅ rpc-transformers/dist/index.node.mjs
 2.92KB -
✅ addresses/dist/index.browser.mjs
 2.8KB -
✅ addresses/dist/index.native.mjs
 2.8KB -
✅ addresses/dist/index.node.mjs
 2.8KB -
✅ library/dist/index.browser.mjs
 2.67KB -
✅ library/dist/index.native.mjs
 2.67KB -
✅ library/dist/index.node.mjs
 2.67KB -
✅ codecs-strings/dist/index.browser.mjs
 2.53KB -
✅ signers/dist/index.browser.mjs
 2.53KB -
✅ signers/dist/index.native.mjs
 2.53KB -
✅ signers/dist/index.node.mjs
 2.53KB -
✅ codecs-strings/dist/index.node.mjs
 2.48KB -
✅ codecs-strings/dist/index.native.mjs
 2.46KB -
✅ transaction-confirmation/dist/index.node.mjs
 2.4KB -
✅ transaction-confirmation/dist/index.native.mj
s
 2.34KB -
✅ transaction-confirmation/dist/index.browser.m
js
 2.34KB -
✅ sysvars/dist/index.browser.mjs
 2.25KB -
✅ sysvars/dist/index.native.mjs
 2.25KB -
✅ sysvars/dist/index.node.mjs
 2.24KB -
✅ rpc-subscriptions-spec/dist/index.node.mjs
 2.13KB -
✅ rpc-subscriptions-spec/dist/index.native.mjs
 2.08KB -
✅ rpc-subscriptions-spec/dist/index.browser.mjs
 2.08KB -
✅ keys/dist/index.browser.mjs
 2.04KB -
✅ keys/dist/index.native.mjs
 2.03KB -
✅ keys/dist/index.node.mjs
 2.03KB -
✅ codecs-numbers/dist/index.native.mjs
 2.01KB -
✅ codecs-numbers/dist/index.browser.mjs
 2.01KB -
✅ codecs-numbers/dist/index.node.mjs
 2.01KB -
✅ transactions/dist/index.browser.mjs
 1.99KB -
✅ react/dist/index.native.mjs
 1.99KB -
✅ transactions/dist/index.native.mjs
 1.99KB -
✅ react/dist/index.browser.mjs
 1.99KB -
✅ react/dist/index.node.mjs
 1.99KB -
✅ transactions/dist/index.node.mjs
 1.99KB -
✅ rpc/dist/index.node.mjs
 1.95KB -
✅ rpc-transport-http/dist/index.browser.mjs
 1.91KB -
✅ rpc-transport-http/dist/index.native.mjs
 1.91KB -
✅ rpc/dist/index.native.mjs
 1.8KB -
✅ subscribable/dist/index.node.mjs
 1.8KB -
✅ rpc/dist/index.browser.mjs
 1.8KB -
✅ rpc-transport-http/dist/index.node.mjs
 1.75KB -
✅ subscribable/dist/index.native.mjs
 1.75KB -
✅ subscribable/dist/index.browser.mjs
 1.74KB -
✅ rpc-types/dist/index.browser.mjs
 1.6KB -
✅ rpc-types/dist/index.native.mjs
 1.6KB -
✅ rpc-types/dist/index.node.mjs
 1.6KB -
✅ rpc-subscriptions-channel-websocket/dist/inde
x.node.mjs
 1.33KB -
✅ rpc-subscriptions-channel-websocket/dist/inde
x.native.mjs
 1.27KB -
✅ rpc-subscriptions-channel-websocket/dist/inde
x.browser.mjs
 1.26KB -
✅ options/dist/index.browser.mjs
 1.18KB -
✅ options/dist/index.native.mjs
 1.18KB -
✅ options/dist/index.node.mjs
 1.17KB -
✅ accounts/dist/index.browser.mjs
 1.13KB -
✅ accounts/dist/index.native.mjs
 1.12KB -
✅ accounts/dist/index.node.mjs
 1.12KB -
✅ compat/dist/index.browser.mjs
 971B -
✅ compat/dist/index.native.mjs
 970B -
✅ compat/dist/index.node.mjs
 968B -
✅ rpc-spec-types/dist/index.browser.mjs
 964B -
✅ rpc-api/dist/index.browser.mjs
 963B -
✅ rpc-api/dist/index.native.mjs
 962B -
✅ rpc-spec-types/dist/index.native.mjs
 962B -
✅ rpc-spec-types/dist/index.node.mjs
 961B -
✅ rpc-api/dist/index.node.mjs
 960B -
✅ rpc-subscriptions-api/dist/index.native.mjs
 870B -
✅ rpc-subscriptions-api/dist/index.node.mjs
 869B -
✅ rpc-subscriptions-api/dist/index.browser.mjs
 868B -
✅ rpc-spec/dist/index.browser.mjs
 829B -
✅ rpc-spec/dist/index.native.mjs
 829B -
✅ rpc-spec/dist/index.node.mjs
 828B -
✅ promises/dist/index.browser.mjs
 799B -
✅ promises/dist/index.native.mjs
 798B -
✅ promises/dist/index.node.mjs
 797B -
✅ assertions/dist/index.browser.mjs
 790B -
✅ instructions/dist/index.browser.mjs
 771B -
✅ instructions/dist/index.native.mjs
 770B -
✅ instructions/dist/index.node.mjs
 768B -
✅ assertions/dist/index.native.mjs
 724B -
✅ fast-stable-stringify/dist/index.browser.mjs
 724B -
✅ assertions/dist/index.node.mjs
 723B -
✅ fast-stable-stringify/dist/index.native.mjs
 723B -
✅ fast-stable-stringify/dist/index.node.mjs
 722B -
✅ programs/dist/index.browser.mjs
 329B -
✅ programs/dist/index.native.mjs
 327B -
✅ programs/dist/index.node.mjs
 325B -
✅ event-target-impl/dist/index.node.mjs
 233B -
✅ functional/dist/index.browser.mjs
 154B -
✅ functional/dist/index.native.mjs
 152B -
✅ text-encoding-impl/dist/index.native.mjs
 152B -
✅ functional/dist/index.node.mjs
 151B -
✅ codecs/dist/index.browser.mjs
 137B -
✅ codecs/dist/index.native.mjs
 136B -
✅ codecs/dist/index.node.mjs
 134B -
✅ event-target-impl/dist/index.browser.mjs
 133B -
✅ ws-impl/dist/index.node.mjs
 131B -
✅ text-encoding-impl/dist/index.browser.mjs
 122B -
✅ text-encoding-impl/dist/index.node.mjs
 119B -
✅ crypto-impl/dist/index.node.mjs
 114B -
✅ ws-impl/dist/index.browser.mjs
 113B -
✅ crypto-impl/dist/index.browser.mjs
 109B -
✅ rpc-parsed-types/dist/index.browser.mjs
 66B -
✅ rpc-parsed-types/dist/index.native.mjs
 65B -
✅ rpc-parsed-types/dist/index.node.mjs
 63B -

No change in files bundle size

Final result: ✅

View report in BundleMon website ➡️

Current branch size history | Target branch size history

@steveluscher steveluscher added this pull request to the merge queue Jan 29, 2025
Merged via the queue into main with commit dedf8b6 Jan 29, 2025
10 checks passed
@steveluscher steveluscher deleted the 01-16-document_solana_compat_with_typedoc branch January 29, 2025 09:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@lorisleiva lorisleiva lorisleiva approved these changes

@buffalojoec buffalojoec Awaiting requested review from buffalojoec

@mcintyre94 mcintyre94 Awaiting requested review from mcintyre94

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@steveluscher @lorisleiva