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

docs: improving getting started docs for mainnet #3500

Open
wants to merge 9 commits into
base: master
Choose a base branch
from

Conversation

arboleya
Copy link
Member

@arboleya arboleya commented Dec 24, 2024

Release notes

In this release, we:

  • Improved the Getting Started docs section for mainnet

Summary

  • Simplifies presentation
  • Removes page duplications
  • Shift the focus for mainnet
  • Isolate unrelated examples
  • Standardize code snippets
  • Improves overall formatting
  • Provides links for everything
  • List sub-items in the page index

For easy reviewing, check the Preview URL:

getting-started

Checklist

  • All changes are covered by tests (or not applicable)
  • All changes are documented (or not applicable)
  • I reviewed the entire PR myself (preferably, on GH UI)
  • I described all Breaking Changes (or there's none)

@arboleya arboleya added the docs Requests pertinent to documentation label Dec 24, 2024
@arboleya arboleya self-assigned this Dec 24, 2024
Copy link

vercel bot commented Dec 24, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
fuels-template ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 24, 2024 1:15pm
ts-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 24, 2024 1:15pm
ts-docs-api ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 24, 2024 1:15pm

Copy link

codspeed-hq bot commented Dec 24, 2024

CodSpeed Performance Report

Merging #3500 will degrade performances by 47.35%

Comparing aa/docs/connect-to-mainnet (2c59a56) with master (41c72fb)

Summary

❌ 1 regressions
✅ 17 untouched benchmarks

⚠️ Please fix the performance issues or acknowledge them on CodSpeed.

Benchmarks breakdown

Benchmark master aa/docs/connect-to-mainnet Change
should successfully conduct a custom transfer between wallets (x20 times) 50.3 ms 95.5 ms -47.35%

Copy link
Contributor

Coverage Report:

Lines Branches Functions Statements
76.33%(+0%) 69.84%(+0%) 74.2%(+0%) 76.34%(+0%)
Changed Files:

Coverage values did not change👌.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Requests pertinent to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Create Connecting To Mainnet Documentation
1 participant