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: rename 'connect to testnet' section #1677

Merged
merged 7 commits into from
Feb 2, 2024
Merged

Conversation

Dhaiwat10
Copy link
Member

@Dhaiwat10 Dhaiwat10 commented Jan 23, 2024

As it turns out, we already have a page that goes over how one can connect to the Fuel testnet. This section was named as 'Connecting to external node' though. I have renamed it to 'Connecting to Testnet' via this PR.

Some ideas for further improvement

  • The reason why the lack of these docs was mentioned in the feedback was probably the fact that they are a bit hidden under the 'Provider' section in the sidebar. Maybe we can move 'guides' like this one to a specific section? The 'Cookbook' section is a good candidate but cookbooks are usually reserved for rather advanced examples. Any thoughts?
  • The example on the page itself demonstrates initializing a wallet on the testnet and does not actually interact with any contracts on the testnet or with the testnet node itself. Maybe we should update the example? Update the 'connecting to testnet' example #1690 (comment)

Closes #1548

@Dhaiwat10 Dhaiwat10 added the docs label Jan 23, 2024
@Dhaiwat10 Dhaiwat10 added this to the 2 - Beetle milestone Jan 23, 2024
@Dhaiwat10 Dhaiwat10 self-assigned this Jan 23, 2024
Copy link
Contributor

Coverage report

St.
Category Percentage Covered / Total
🟢 Statements 86.91% 6159/7087
🟡 Branches 70.9% 965/1361
🟡 Functions 77.95% 1011/1297
🟢 Lines 86.89% 5903/6794

Test suite run success

1482 tests passing in 263 suites.

Report generated by 🧪jest coverage report action from 6a323cf

@danielbate
Copy link
Contributor

Yeah I think these two should be handled separately. I definitely agree with renaming the page if that's what come from the feedback. Most other docs seem to reference it as a Testnet anyways.

The first point around hidden docs probably needs a bit more thought. We have vastly improved our documentation and added a lot more content, but it probably does need a more of a top-down approach now and see what we have and what's missing and whether the structure could be improved.

@Dhaiwat10
Copy link
Member Author

@danielbate sounds fair. I'm gonna scope this PR to just renaming the section for now, then.

I'll file a separate issue to update the code in the example once beta-5 is officially up. We can then have the code example demonstrate how to interact with a live contract on the beta-5 testnet.

@Dhaiwat10
Copy link
Member Author

Opened a discussion: #1690 (comment)

@Dhaiwat10 Dhaiwat10 marked this pull request as ready for review January 26, 2024 21:15
@arboleya arboleya modified the milestones: 2 - Beetle, 3 - Wasp Jan 31, 2024
@arboleya arboleya removed this from the 3 - Wasp milestone Feb 1, 2024
@Dhaiwat10 Dhaiwat10 enabled auto-merge (squash) February 2, 2024 23:01
Copy link
Contributor

github-actions bot commented Feb 2, 2024

Coverage Report:

Lines Branches Functions Statements
78.42%(+0%) 68.43%(+0%) 76.65%(+0%) 78.39%(+0%)
Changed Files:

Coverage values did not change👌.

@Dhaiwat10 Dhaiwat10 merged commit 2d3587b into master Feb 2, 2024
16 checks passed
@Dhaiwat10 Dhaiwat10 deleted the dp/connecting-to-testnet branch February 2, 2024 23:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

How to connect to testnet
4 participants