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.

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

4.x doc improvements #2 #6681

Merged
merged 2 commits into from
Jan 4, 2024
Merged

4.x doc improvements #2 #6681

merged 2 commits into from
Jan 4, 2024

Conversation

luu-alex
Copy link
Contributor

@luu-alex luu-alex commented Jan 3, 2024

In this PR:
removes defined in section to remove broken links
updates typedoc

Theres no plugin available to remove sections, hierarchy, implements or overrides without having to create our own.
TypeStrong/typedoc#2471

Description

Please include a summary of the changes and be sure to follow our Contribution Guidelines.

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)

Checklist:

  • I have selected the correct base branch.
  • I have performed a self-review of my own code.
  • I have commented my code, particularly in hard-to-understand areas.
  • I have made corresponding changes to the documentation.
  • My changes generate no new warnings.
  • Any dependent changes have been merged and published in downstream modules.
  • I ran npm run lint with success and extended the tests and types if necessary.
  • I ran npm run test:unit with success.
  • I ran npm run test:coverage and my test cases cover all the lines and branches of the added code.
  • I ran npm run build and tested dist/web3.min.js in a browser.
  • I have tested my code on the live network.
  • I have checked the Deploy Preview and it looks correct.
  • I have updated the CHANGELOG.md file in the root folder.
  • I have linked Issue(s) with this PR in "Linked Issues" menu.

@luu-alex luu-alex marked this pull request as ready for review January 3, 2024 18:23
Copy link

github-actions bot commented Jan 3, 2024

Bundle Stats

Hey there, this message comes from a github action that helps you and reviewers to understand how these changes affect the size of this project's bundle.

As this PR is updated, I'll keep you updated on how the bundle size is impacted.

Total

Asset Old size New size Diff Diff %
Total 591 KB 591 KB 0 0.00%
View detailed bundle breakdown

Added

No assets were added

Removed

No assets were removed

Bigger

No assets were bigger

Smaller

No assets were smaller

Unchanged

Asset Old size New size Diff Diff %
web3.min.js 573 KB 573 KB 0 0.00%
../lib/commonjs/index.d.ts 8.63 KB 8.63 KB 0 0.00%
../lib/commonjs/accounts.d.ts 3.89 KB 3.89 KB 0 0.00%
../lib/commonjs/types.d.ts 2.45 KB 2.45 KB 0 0.00%
../lib/commonjs/web3.d.ts 1.14 KB 1.14 KB 0 0.00%
../lib/commonjs/abi.d.ts 999 bytes 999 bytes 0 0.00%
../lib/commonjs/eth.exports.d.ts 280 bytes 280 bytes 0 0.00%
../lib/commonjs/providers.exports.d.ts 148 bytes 148 bytes 0 0.00%
../lib/commonjs/version.d.ts 60 bytes 60 bytes 0 0.00%

Copy link

github-actions bot commented Jan 3, 2024

Benchmark

Benchmark suite Current: d4621f2 Previous: 6c075db Ratio
processingTx 9256 ops/sec (±3.93%) 9301 ops/sec (±4.81%) 1.00
processingContractDeploy 38479 ops/sec (±12.23%) 39129 ops/sec (±7.62%) 1.02
processingContractMethodSend 20124 ops/sec (±5.05%) 19443 ops/sec (±5.19%) 0.97
processingContractMethodCall 39428 ops/sec (±6.04%) 38971 ops/sec (±6.34%) 0.99
abiEncode 45129 ops/sec (±7.02%) 44252 ops/sec (±6.92%) 0.98
abiDecode 31583 ops/sec (±9.63%) 30419 ops/sec (±8.89%) 0.96
sign 1652 ops/sec (±5.17%) 1656 ops/sec (±4.08%) 1.00
verify 379 ops/sec (±0.56%) 373 ops/sec (±0.78%) 0.98

This comment was automatically generated by workflow using github-action-benchmark.

Copy link

cloudflare-workers-and-pages bot commented Jan 3, 2024

Deploying with  Cloudflare Pages  Cloudflare Pages

Latest commit: d4621f2
Status: ✅  Deploy successful!
Preview URL: https://ddad138b.web3-js-docs.pages.dev
Branch Preview URL: https://6609.web3-js-docs.pages.dev

View logs

Copy link

codecov bot commented Jan 3, 2024

Codecov Report

Merging #6681 (d4621f2) into 4.x (6c075db) will not change coverage.
The diff coverage is n/a.

Additional details and impacted files
@@           Coverage Diff           @@
##              4.x    #6681   +/-   ##
=======================================
  Coverage   91.46%   91.46%           
=======================================
  Files         214      214           
  Lines        8155     8155           
  Branches     2193     2193           
=======================================
  Hits         7459     7459           
  Misses        696      696           
Flag Coverage Δ
UnitTests 91.46% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Components Coverage Δ
web3 ∅ <ø> (∅)
web3-core ∅ <ø> (∅)
web3-errors ∅ <ø> (∅)
web3-eth ∅ <ø> (∅)
web3-eth-abi ∅ <ø> (∅)
web3-eth-accounts ∅ <ø> (∅)
web3-eth-contract ∅ <ø> (∅)
web3-eth-ens ∅ <ø> (∅)
web3-eth-iban ∅ <ø> (∅)
web3-eth-personal ∅ <ø> (∅)
web3-net ∅ <ø> (∅)
web3-providers-http ∅ <ø> (∅)
web3-providers-ipc ∅ <ø> (∅)
web3-providers-ws ∅ <ø> (∅)
web3-rpc-methods ∅ <ø> (∅)
web3-utils ∅ <ø> (∅)
web3-validator ∅ <ø> (∅)

@luu-alex luu-alex merged commit 0c67cc6 into 4.x Jan 4, 2024
61 of 66 checks passed
@luu-alex luu-alex deleted the 6609 branch January 4, 2024 14:12
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.

3 participants