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

fix(docs): introduction #7083

Merged
merged 3 commits into from
Jun 5, 2024
Merged

fix(docs): introduction #7083

merged 3 commits into from
Jun 5, 2024

Conversation

danforbes
Copy link
Contributor

Description

  • In header navbar, libdocs link has been renamed from "Documentation" to "Packages"
  • Added a "Using These Docs" section to Introduction
  • Added a section about plugins to Introduction

Copy link

github-actions bot commented Jun 4, 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

Files count Total bundle size % Changed
10 630.32 kB 0%

Changeset

No files were changed

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 File Size % Changed
web3.min.js 611.03 kB 0%
../lib/commonjs/index.d.ts 8.69 kB 0%
../lib/commonjs/accounts.d.ts 3.89 kB 0%
../lib/commonjs/types.d.ts 2.67 kB 0%
../lib/commonjs/web3.d.ts 1.35 kB 0%
../lib/commonjs/web3_eip6963.d.ts 1.2 kB 0%
../lib/commonjs/abi.d.ts 999 B 0%
../lib/commonjs/eth.exports.d.ts 280 B 0%
../lib/commonjs/providers.exports.d.ts 183 B 0%
../lib/commonjs/version.d.ts 60 B 0%

Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Benchmark

Benchmark suite Current: e4ba0aa Previous: 94f4f82 Ratio
processingTx 9242 ops/sec (±3.70%) 8833 ops/sec (±4.02%) 0.96
processingContractDeploy 39996 ops/sec (±7.54%) 35881 ops/sec (±7.95%) 0.90
processingContractMethodSend 19685 ops/sec (±7.97%) 18484 ops/sec (±4.82%) 0.94
processingContractMethodCall 38139 ops/sec (±6.07%) 37028 ops/sec (±4.19%) 0.97
abiEncode 44613 ops/sec (±6.34%) 39527 ops/sec (±7.28%) 0.89
abiDecode 29505 ops/sec (±8.62%) 27646 ops/sec (±8.72%) 0.94
sign 1558 ops/sec (±2.93%) 1571 ops/sec (±0.91%) 1.01
verify 369 ops/sec (±0.90%) 360 ops/sec (±2.83%) 0.98

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

Copy link

codecov bot commented Jun 4, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 93.98%. Comparing base (94f4f82) to head (e4ba0aa).

Additional details and impacted files
@@           Coverage Diff           @@
##              4.x    #7083   +/-   ##
=======================================
  Coverage   93.98%   93.98%           
=======================================
  Files         215      215           
  Lines        8335     8335           
  Branches     2301     2301           
=======================================
  Hits         7834     7834           
  Misses        501      501           
Flag Coverage Δ
UnitTests 93.98% <ø> (ø)

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 ∅ <ø> (∅)


- [zkSync Plugin](https://www.npmjs.com/package/web3-plugin-zksync)

## Features of Web3.js v4
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we should keep this overview under introduction section

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

but at same time if we want to highlight "Using These Docs" section , what do you think about using https://docusaurus.io/docs/markdown-features/admonitions ?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh, I just moved the section back to its original location 😅 Are you suggesting that "Features of Web3.js v4" get moved back to its original location and then we use an admonition for the "Using These Docs" section? I do not necessarily like the idea of using an admonition for "Using These Docs" as I think it's too much text to go into an admonition...

Copy link
Contributor

@jdevcs jdevcs left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks good, just added few updates ideas, Thanks @danforbes

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.

2 participants