fuellabs / docs-hub Goto Github PK

I think we still have something lingering in the glossary.

The resulting link below points to this [broken] page:

• https://docs.fuel.network/docs/intro/glossary/#indexer

Use the TestAction component to define unit testing for the commands featured in docs/guides/installation/index.md, such as “installing rust” or "installing fuelup"

This repo will attract a lot of external contributors. It would help in the long run to introduce a few issue templates that can allow devs to swiftly raise an issue. Currently we only have the option for a blank issue but we can introduce a few simple templates.

This guide has to be the easiest guide ever, had some issues which i already pointed out. Everything else is smooth. Credit to the dev.

The quickstart contains sections for a contract and a frontend but does not contain a guide for the faucet.

It may be obvious to us but if someone has never used a faucet then a couple sentences and images would be useful for them.

Once intro to sway has been deployed and merged, pull in the new code into the docs.

FuelLabs/intro-to-sway#30

In the previous book we had the networks section containing useful information about each release, fauet, graphql, etc.
I think that we should have something similar for testnet. Meanwhile, we can add the RPC endpoint link at the bottom of the contract quickstart.

While trying to connect my fuel wallet to the bridge site, https://app.fuel.network/portal/bridge, i am still being required to install my fuel wallet even when i have the extension installed.
The site is not able to detect installed wallet, please kindly look into this.

Firstly open the link above and tried connecting my fuel wallet, then i was redirected to the the chromestore home page to install the fuel wallet

User encountered an error when using the --relayer-log-page-size 10000 command.
The error message received was:

Log response size exceeded. You can make eth_getLogs requests with up to a 2K block range and no limit on the response size, or you can request any block range with a cap of 10K logs in the response.

Forum post:
https://forum.fuel.network/t/node-error-query-returned-more-than-10000-results/3713

Suggested Documentation Update:

It appears that the --relayer-log-page-size 10000 command does not function as expected. Based on the error message, I recommend updating the documentation to reflect a revised command:

Change from:
--relayer-log-page-size 10000

Change to:
--relayer-log-page-size 2000

• Wallet CLI
• Deployment

Wallet CLI and deployment are not tested in the playwrite test

The quickstart contains sections for a contract and a frontend but does not contain a guide for the bridge.

If a user has not engaged in defi or bridging then the interface may not be intuitive for them even if it is relatively standardized across projects and thus generally understood to be simple enough to understand.

We ought to add a step-by-step process of how to bridge and what the components in the user interface represent such as choosing a network (which box it's in), the coins, value, time to bridge, wallet pop up confirmations etc.

env

$ npm --version
10.2.4

$ pnpm --version
8.11.0

node --version
v21.3.0

Reproduce:

1. run pnpm install
2. run pnpm dev
3. everything is good, except opening http://127.0.0.1:3000 in browser, shows error

 ⨯ ReferenceError: document is not defined
    at /home/halimao/Documents/Workspace/js/github.com/Halimao/docs-hub/node_modules/.pnpm/[email protected]/node_modules/plyr/dist/plyr.js:302:21
    at /home/halimao/Documents/Workspace/js/github.com/Halimao/docs-hub/node_modules/.pnpm/[email protected]/node_modules/plyr/dist/plyr.js:311:5
    at /home/halimao/Documents/Workspace/js/github.com/Halimao/docs-hub/node_modules/.pnpm/[email protected]/node_modules/plyr/dist/plyr.js:2:83
    at Object.<anonymous> (/home/halimao/Documents/Workspace/js/github.com/Halimao/docs-hub/node_modules/.pnpm/[email protected]/node_modules/plyr/dist/plyr.js:5:3)
    at Module._compile (node:internal/modules/cjs/loader:1376:14)
    at Object.Module._extensions..js (node:internal/modules/cjs/loader:1435:10)
    at Module.load (node:internal/modules/cjs/loader:1207:32)
    at Function.Module._load (node:internal/modules/cjs/loader:1023:12)
    at Module.call (node:internal/modules/cjs/loader:1235:19)
    at Module.mod.require (/home/halimao/Documents/Workspace/js/github.com/Halimao/docs-hub/node_modules/.pnpm/[email protected]_@[email protected][email protected][email protected]/node_modules/next/src/server/require-hook.ts:69:26)
    at require (node:internal/modules/helpers:176:18)
    at Object.<anonymous> (/home/halimao/Documents/Workspace/js/github.com/Halimao/docs-hub/node_modules/.pnpm/[email protected][email protected][email protected]/node_modules/plyr-react/index.js:6:14)
    at Module._compile (node:internal/modules/cjs/loader:1376:14)
    at Object.Module._extensions..js (node:internal/modules/cjs/loader:1435:10)
    at Module.load (node:internal/modules/cjs/loader:1207:32) {
  page: '/'
}
 ✓ Compiled /_error in 338ms (3184 modules)

Content in the browser:

full log:

Server Error
ReferenceError: document is not defined

This error happened while generating the page. Any console logs will be displayed in the terminal window.
Call Stack
<unknown>
file:///home/halimao/Documents/Workspace/js/github.com/Halimao/docs-hub/node_modules/.pnpm/[email protected]/node_modules/plyr/dist/plyr.js (302:21)
<unknown>
file:///home/halimao/Documents/Workspace/js/github.com/Halimao/docs-hub/node_modules/.pnpm/[email protected]/node_modules/plyr/dist/plyr.js (311:5)
<unknown>
file:///home/halimao/Documents/Workspace/js/github.com/Halimao/docs-hub/node_modules/.pnpm/[email protected]/node_modules/plyr/dist/plyr.js (2:83)
Object.<anonymous>
file:///home/halimao/Documents/Workspace/js/github.com/Halimao/docs-hub/node_modules/.pnpm/[email protected]/node_modules/plyr/dist/plyr.js (5:3)
Module._compile
node:internal/modules/cjs/loader (1376:14)
Object.Module._extensions..js
node:internal/modules/cjs/loader (1435:10)
Module.load
node:internal/modules/cjs/loader (1207:32)
Function.Module._load
node:internal/modules/cjs/loader (1023:12)
Module.call
node:internal/modules/cjs/loader (1235:19)
Module.mod.require
file:///home/halimao/Documents/Workspace/js/github.com/Halimao/docs-hub/node_modules/.pnpm/[email protected]_@[email protected][email protected][email protected]/node_modules/next/src/server/require-hook.ts (69:26)
require
node:internal/modules/helpers (176:18)
Object.<anonymous>
file:///home/halimao/Documents/Workspace/js/github.com/Halimao/docs-hub/node_modules/.pnpm/[email protected][email protected][email protected]/node_modules/plyr-react/index.js (6:14)
Module._compile
node:internal/modules/cjs/loader (1376:14)
Object.Module._extensions..js
node:internal/modules/cjs/loader (1435:10)
Module.load
node:internal/modules/cjs/loader (1207:32)

For example:

https://github.com/FuelLabs/docs-hub/actions/runs/8443678227/job/23173027779?pr=211

Hello sir, when I was testing fuel, I found a bug in the fuel wallet. The details are as follows:

When I registered, the mnemonic words displayed on the interface were as shown in Figure 1. When I wanted to import this wallet into fuelet again, I opened the wallet mnemonic words interface and found that the mnemonic words were different from the ones I had taken before, as shown in Figure 2. And both wallets can work normally, and both sets of mnemonics are effective! I think this is a huge bug!

Hello sir, when I was testing fuel, I found a bug in the fuel wallet. The details are as follows:

Figure 1

Figure 2

email：[email protected]

"Working with commands is one of the key elements of the docs experience.
It always comes to 3 things:

What it does

What's the command I need to copy-paste

What's the expected result.

Currently the docs hub is using for wrapping all of the above.

I suppose the forc wallet command should be included on the list of available forc commands here:

https://docs.fuel.network/docs/forc/commands/

The documentation hub should allow users to toggle between different release versions.

1. The codeImport function from src\lib\plugins\code-import.ts is actually making the job of extracting the content. ✅

2. However its not being rendered by src\components\CodeImport.tsx but by src\components\Code.tsx ⚠️

3. The src\lib\md-plugins.ts file exports the codeImport function from #1 as remarkPlugins. ✅

4.The same src\lib\md-plugins.ts file exports another codeImport function from src\lib\plugins\rehype-code.ts ⚠️

5. The second codeImport function specifies that node.name !== 'CodeImport' gets rendered by a 'code' element.

6. Then, src\components\MDXRender.tsx maps 'code' elements to the Code.ts component

7. The codeImport function from src\lib\plugins\rehype-code.ts Actually does the same as src\components\CodeImport.tsx by manually composing the elements.

//codeImport function from src\lib\plugins\rehype-code.ts

node.type = 'element';
node.tagName = 'pre';
const lang = node.attributes?.find((a: any) => a.name === '__language');
const code = h('code', { class: lang?.value }, content?.value);
node.children = [code];
vs
// src\components\CodeImport.tsx
return <pre className={language-${language}}>{content};

This issue was found during the elaboration of the installation guide. The main intention was to import content from other mdx files to compose another mdx file to be rendered by the app.

Trying to bypass the rehype plugin was not enough, in the mean time a "MDXIimport" component must be added as a hot fix.

Related to issue: FuelLabs/fuels-ts#1960

Summary

TypeScript code snippets have import statements, which aren't being rendered correctly (examples below).

• Docs Hub
  // #import { bn, Contract, FunctionInvocationResult };
• Fuels-ts Docs
  import { FunctionInvocationResult, Contract, bn } from 'fuels';

The fuels-ts docs has a custom plugin which renders our code snippet imports.

I believe there is work to be done on both repositories, so it would be good to align on this.

Expected

Code snippet imports to be rendered correctly.

e.g. import { FunctionInvocationResult, Contract, bn } from 'fuels';

Actual

Code snippet imports are not rendered.

e.g. // #import { bn, Contract, FunctionInvocationResult };

The documentation was updated to handle a dynamic testnet name by using {props.fuelTestnet}, however, is not being successfully rendered i some places such as the installation guide.

Be aware that the url also has the same issue.
https://docs.fuel.network/guides/installation/#installing-the-propsfueltestnet-toolchain

Currently, the docs-hub pulls versions from our package @fuel-ts/versions here.

As part of FuelLabs/fuels-ts#2108, we added a new variable fuelsInstallVersion to our documentation versions, to ensure that users install a testnet compatible version of the SDK.

Actual

This currently doesn't render due to not being available from the current version source.

Expected

The {{fuelsInstallVersion}} to render from our documentation versions.

Expected Behavior

Currently the docs link - Fuelup check toolchain on running the fuelup show command gives output which mentions beta-4-x86_64-unknown-linux-gnu (default) as the active toolchain.

But the last line in the docs mention - As you can see, the beta-5 toolchain is active 🚀. This might be confusing to devs looking to setup fuel.

Actual Behavior

Replace the actual output with the right output (beta-5)

The quickstart contains sections for a contract and a frontend but does not contain a guide for the indexer.

Indexing your own data or connecting to an external index is an important and common use case. We ought to have a guide which uses the contract from the quickstart as a target for indexing.

FuelLabs/sway#5181

Bumping cargo generate template will break playwrite tests for quickstart in the contracts section

Related to issue: FuelLabs/fuels-ts#1960

Summary

In the following example, we are missing the version replacement for {{fuels}}.

Expected

The {{fuels}} string should be replaced with the version number.

https://cdnjs.cloudflare.com/ajax/libs/fuels/0.79.0/browser.mjs

Actual

The {{fuels}} string is not replaced.

https://cdnjs.cloudflare.com/ajax/libs/fuels/{{fuels}}/browser.mjs

One cannot filter what section the search is part of. When searching "asset", the only sections that show are Fuel wallet and Fuel TS SDK when I need Sway.

The std-lib also does not show up in the search. Looking up transfer does not yield the std-lib's transfer function. Something like "Storagebytes" yields 0 results.

What version of fuels-ts are you using?

https://www.fuel.network/

Steps to Reproduce

https://docs.fuel.network/docs/indexer/. this we need the indexer

Expected Behavior

there should be an indexer on the page this should make it to work perfectly fine.

Actual Behavior

https://docs.fuel.network/docs/indexer/. error page turning up

The documentation links to https://fuellabs.github.io/sway/master/std/, however this link is broken.

Related to issue: FuelLabs/fuels-ts#1960

Summary

The fuels-ts documentation has a "Code in context button" which takes the user to the related code in GitHub.

Source

The code in context link within the fuels-ts docs takes up a lot of real estate. Potential a button within the snippet would be better (terrible mock up below).

It's be good to have similar functionality within the Docs Hub, as it allows users to dive deeper.

In all the 'running a node' guides, the minimum requirements are missing. For example, they should include 8 GB of RAM and at least 1 TB of free disk space.

Optimization Strategies for Playwright Tests

1. Parallel Execution: Currently, Playwright tests utilize only one worker in a single-threaded mode. However, these tests are capable of running in parallel. Implementing parallel execution can significantly reduce the overall test execution time.

Solved by #55

3. Reduced Action Timeouts: The current configuration includes a generous time limit for each action. Optimizing these timeouts—reducing them to the minimum necessary duration—can accelerate test completion without compromising on reliability.

All docs should be run through a linter. Especially once it is merged to master it is instantly public facing.

• Running local node
• Running beta 4 ndoe
  https://docs.fuel.network/guides/running-a-node/

On the right there is a scroll bar that cannot be scrolled and I cannot use the scroll wheel to scroll down the page. I must click the navigation headings in the top right to make the page scroll down to the section.

Had issues after importing my wallet during contract deployment code. Forc command couldnt detect the imported wallet.

I see this exception is happening again like it did with issue #189

Visit this page:

I searched for connectors, clicked on the first result and see the exception

https://docs.fuel.network/docs/fuels-ts/account/fuel/

Please let me know if you need more information

Related to issue: FuelLabs/fuels-ts#1960

Summary

Syntax highlighting is not working for the HTML based code snippet.

Expected

To highlight the code snippet with the correct syntax (HTML).

Actual

The code snippet is not highlighted.

The way that I got this exception, I went through the following steps:

1. I navigates to https://docs.fuel.network/
2. Clicked on the Search Bar, entered "Bridge" and clicked on the first entry

3. And then came the exception shown in the image.

Note, this doesn't happen every time but when reloading the page, I see the exception is getting thrown intermittently. I hope you can also catch/reproduce it. Contact me if you need more details.

docs.fuel.network-1708957426064.log - exception details can be found in this log file

The expected behaviour is for the glossary page to appear at the Bridge entry.

Incorrect menu ordering for the TypeScript SDK -> Getting Started section.

Actual

Expected

Currently the documentation instructs the user to install the @fuels/connectors with the incorrect version.

Actual

@fuels/[email protected]

Expected

@fuels/[email protected]

The Sway-Libs Book has been created and needs to be added to the docs hub. https://fuellabs.github.io/sway-libs/book/index.html

The Sway-Libs docs have also been created https://fuellabs.github.io/sway-libs/master/sway_libs/

curl -sSf https://install.fuel.network/fuelup-init.sh | sh"

--proto '=https' --tlsv1.2 can be removed right away as suggested by @cold-briu