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

Proposal for rearranging docs #6141

Merged
merged 6 commits into from
Jun 2, 2023
Merged

Proposal for rearranging docs #6141

merged 6 commits into from
Jun 2, 2023

Conversation

mpetrunic
Copy link
Contributor

Description

Docs seemed like a bit over the place with Guide/Tutorials. This PR tries to organize docs into a single page where previous "tutorials" are added as "Example" subpage in guides.
A landing page is removed and users are welcomed in the getting started section of the docs.
Removed "Raw Transaction" section as it was just a c/p from local wallet section.

Obviously a lot of content regarding smart contract and transaction is still missing^^

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.

Signed-off-by: Marin Petrunic <marin.petrunic@gmail.com>
@mpetrunic mpetrunic marked this pull request as ready for review June 1, 2023 10:24
@github-actions
Copy link

github-actions bot commented Jun 1, 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 638 KB 638 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 621 KB 621 KB 0 0.00%
../lib/commonjs/index.d.ts 8.44 KB 8.44 KB 0 0.00%
../lib/commonjs/accounts.d.ts 3.67 KB 3.67 KB 0 0.00%
../lib/commonjs/types.d.ts 2.37 KB 2.37 KB 0 0.00%
../lib/commonjs/abi.d.ts 1000 bytes 1000 bytes 0 0.00%
../lib/commonjs/web3.d.ts 811 bytes 811 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%

@codecov
Copy link

codecov bot commented Jun 1, 2023

Codecov Report

Merging #6141 (9429443) into 4.x (88ac791) will not change coverage.
The diff coverage is n/a.

Additional details and impacted files
@@           Coverage Diff           @@
##              4.x    #6141   +/-   ##
=======================================
  Coverage   87.37%   87.37%           
=======================================
  Files         197      197           
  Lines        7548     7548           
  Branches     2059     2059           
=======================================
  Hits         6595     6595           
  Misses        953      953           
Flag Coverage Δ
UnitTests 87.37% <ø> (ø)

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
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.

doc is not building (seems due to broken links) , it needs a fix . Thanks @mpetrunic

@mpetrunic
Copy link
Contributor Author

@jdevcs working on it, didnt show during yarn start 😓

Signed-off-by: Marin Petrunic <marin.petrunic@gmail.com>
@mpetrunic
Copy link
Contributor Author

doc is not building (seems due to broken links) , it needs a fix . Thanks @mpetrunic

We need to use my fork until milesj/docusaurus-plugin-typedoc-api#99 gets merged as current version has docs base path hardcoded 🤦🏻‍♂️

Signed-off-by: Marin Petrunic <marin.petrunic@gmail.com>
Signed-off-by: Marin Petrunic <marin.petrunic@gmail.com>
@cloudflare-pages
Copy link

cloudflare-pages bot commented Jun 1, 2023

Deploying with  Cloudflare Pages  Cloudflare Pages

Latest commit: 9429443
Status: ✅  Deploy successful!
Preview URL: https://95366485.web3-js-docs.pages.dev
Branch Preview URL: https://arrange-docs.web3-js-docs.pages.dev

View logs

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.

There are some merge conflicts.

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