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

4x clean docs #6582

Merged
merged 25 commits into from
Nov 20, 2023
Merged

4x clean docs #6582

merged 25 commits into from
Nov 20, 2023

Conversation

jdevcs
Copy link
Contributor

@jdevcs jdevcs commented Nov 8, 2023

Description

#6579

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.

Copy link

github-actions bot commented Nov 8, 2023

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 588 KB 588 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 571 KB 571 KB 0 0.00%
../lib/commonjs/index.d.ts 8.63 KB 8.63 KB 0 0.00%
../lib/commonjs/accounts.d.ts 3.67 KB 3.67 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 1000 bytes 1000 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

codecov bot commented Nov 8, 2023

Codecov Report

Merging #6582 (d1e4f59) into 4.x (4358140) will increase coverage by 2.19%.
Report is 107 commits behind head on 4.x.
The diff coverage is 94.14%.

❗ Current head d1e4f59 differs from pull request most recent head aeeb04e. Consider uploading reports for the commit aeeb04e to get more accurate results

Additional details and impacted files
@@            Coverage Diff             @@
##              4.x    #6582      +/-   ##
==========================================
+ Coverage   87.37%   89.57%   +2.19%     
==========================================
  Files         197      215      +18     
  Lines        7548     8276     +728     
  Branches     2059     2242     +183     
==========================================
+ Hits         6595     7413     +818     
+ Misses        953      863      -90     
Flag Coverage Δ
UnitTests 89.57% <94.14%> (+2.19%) ⬆️

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

Copy link

cloudflare-pages bot commented Nov 9, 2023

Deploying with  Cloudflare Pages  Cloudflare Pages

Latest commit: aeeb04e
Status: ✅  Deploy successful!
Preview URL: https://7f4da75b.web3-js-docs.pages.dev
Branch Preview URL: https://junaid-4xcleandocs.web3-js-docs.pages.dev

View logs

@jdevcs jdevcs marked this pull request as ready for review November 10, 2023 16:36
@jdevcs jdevcs requested a review from avkos as a code owner November 10, 2023 16:36
@jdevcs
Copy link
Contributor Author

jdevcs commented Nov 10, 2023

Basic clean doc creation is complete and preview URL is : https://junaid-4xcleandocs.web3-js-docs.pages.dev/libdocs/Accounts

For remaining improvements I'll create some issues and we can make more attractive UX in new PRs.

Copy link
Contributor

@Muhammad-Altabba Muhammad-Altabba left a comment

Choose a reason for hiding this comment

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

Great job!

And if you can, please, in the PR or in the future ones to update the title of this "README":
image

@jdevcs
Copy link
Contributor Author

jdevcs commented Nov 20, 2023

Great job!

And if you can, please, in the PR or in the future ones to update the title of this "README": image

I think we should have more nicer landing page under documentation link instead of readme, so I removed readme for now. and In some next PR we should add another landing page pointing to web3 package / intro, some thing like getting started landing page https://docs.web3js.org/

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.

None yet

3 participants