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

Make documentation and examples more prominent in README #26498

Merged
merged 3 commits into from
Jul 8, 2022

Conversation

mikemaccana
Copy link
Contributor

Problem

There's a lot more documentation to this library than many users would see looking at the current README

Summary of Changes

  • Make a dedicated 'Documentation and examples' heading
  • Bring the Solana Cookbook (which has more examples than all the other documentation listed in the README) to the top
  • Mention the examples higher up in the README

There's a lot more documentation to this library than many users would see looking at the current README

- Make a dedicated 'Documentation and examples' heading
- Bring the Solana Cookbook (which has more examples than all the other documentation listed in the README) to the top 
- Mention the examples higher up in the README
@mergify mergify bot added the community Community contribution label Jul 8, 2022
@mergify mergify bot requested a review from a team July 8, 2022 10:00
web3.js/README.md Outdated Show resolved Hide resolved
web3.js/README.md Outdated Show resolved Hide resolved
web3.js/README.md Outdated Show resolved Hide resolved
@codecov
Copy link

codecov bot commented Jul 8, 2022

Codecov Report

Merging #26498 (c593e86) into master (1165a7f) will decrease coverage by 5.8%.
The diff coverage is n/a.

@@             Coverage Diff             @@
##           master   #26498       +/-   ##
===========================================
- Coverage    81.9%    76.0%     -5.9%     
===========================================
  Files         631       40      -591     
  Lines      174252     2370   -171882     
  Branches        0      343      +343     
===========================================
- Hits       142728     1803   -140925     
+ Misses      31524      449    -31075     
- Partials        0      118      +118     

@jstarry jstarry merged commit 6d7a569 into solana-labs:master Jul 8, 2022
jeffwashington pushed a commit to jeffwashington/solana that referenced this pull request Jul 10, 2022
…na-labs#26498)

* Make documentation and examples more prominent in README

There's a lot more documentation to this library than many users would see looking at the current README

- Make a dedicated 'Documentation and examples' heading
- Bring the Solana Cookbook (which has more examples than all the other documentation listed in the README) to the top 
- Mention the examples higher up in the README

* Update web3.js/README.md

* Update web3.js/README.md
@mikemaccana mikemaccana deleted the patch-2 branch July 11, 2022 09:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
community Community contribution
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants