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.

Sign up for GitHub

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

Jump to bottom

docs: improving getting started docs for mainnet #3500

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

docs: improving getting started docs for mainnet #3500

wants to merge 16 commits into from

Conversation

arboleya
Copy link
Member

@arboleya arboleya commented Dec 24, 2024 •
edited
Loading

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:

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
@vercel Vercel
Copy link

vercel bot commented Dec 24, 2024 •
edited
Loading

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 31, 2024 0:51am
ts-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 31, 2024 0:51am
ts-docs-api ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 31, 2024 0:51am

@codspeed-hq CodSpeed HQ
Copy link

codspeed-hq bot commented Dec 24, 2024 •
edited
Loading

CodSpeed Performance Report

Merging #3500 will degrade performances by 20.16%

Comparing aa/docs/connect-to-mainnet (b4a3327) 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 63 ms -20.16%

@arboleya arboleya mentioned this pull request Dec 31, 2024
Open
danielbate
danielbate previously approved these changes Dec 31, 2024
View reviewed changes
nedsalk
nedsalk previously approved these changes Dec 31, 2024
View reviewed changes
petertonysmith94
petertonysmith94 reviewed Dec 31, 2024
View reviewed changes
Copy link
Contributor

@petertonysmith94 petertonysmith94 left a comment

Choose a reason for hiding this comment

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

Needs linting :)

@github-actions GitHub Actions
Copy link
Contributor

Coverage Report:

Lines Branches Functions Statements
77.83%(+0%) 70.5%(+0.03%) 75.5%(+0%) 77.79%(+0%)
Changed Files:
Ok File (✨=New File) Lines Branches Functions Statements
🔴 packages/account/src/providers/transaction-request/transaction-request.ts 88.57%
(+0%)		 78.08%
(+1.37%)		 84%
(+0%)		 88.81%
(+0%)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@petertonysmith94 petertonysmith94 petertonysmith94 left review comments

@nedsalk nedsalk nedsalk approved these changes

@digorithm digorithm Awaiting requested review from digorithm digorithm is a code owner

@Torres-ssf Torres-ssf Awaiting requested review from Torres-ssf Torres-ssf is a code owner

@Dhaiwat10 Dhaiwat10 Awaiting requested review from Dhaiwat10 Dhaiwat10 is a code owner

@maschad maschad Awaiting requested review from maschad maschad is a code owner

@danielbate danielbate Awaiting requested review from danielbate danielbate is a code owner

At least 3 approving reviews are required to merge this pull request.

Assignees

@arboleya arboleya

Labels
docs Requests pertinent to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Create Connecting To Mainnet Documentation
4 participants
@arboleya @danielbate @petertonysmith94 @nedsalk