Docs are now maintained at https://github.com/FuelLabs/docs-hub
Install mdbook
and then open a new terminal session in order to run the subsequent commands.
cargo install mdbook
To build book:
mdbook build
To serve locally:
mdbook serve
📃 Top-level documentation for Fuel
Home Page: https://fuellabs.github.io/fuel-docs/master
License: Apache License 2.0
Docs are now maintained at https://github.com/FuelLabs/docs-hub
Install mdbook
and then open a new terminal session in order to run the subsequent commands.
cargo install mdbook
To build book:
mdbook build
To serve locally:
mdbook serve
The new process that uses cargo generate
is documented in https://fuellabs.github.io/sway/master/testing/testing-with-rust.html . This is going to be in effect as of the next forc
release.
I just read this doc on Addresses and I'm wondering if someone can please point me to docs on how the Fuel address registry works? If an address isn't registered, is a 20 byte address used? If so, why does an address on testnet-beta-1 block explorer use an address that contains 255 binary digits (so more than 20 bytes)?
There is a note at the bottom of this page which states the versions in the app repo. It's wrong. Remove it instead of bumping it every so often or outline that each app has its own versions and they should be listed in the app itself.
For some time now, installing a new toolchain automatically defaults to that toolchain.
beta-4
(and perhaps 3 and older) list how to switch to the toolchain after it has been installed.
That is unnecessary for the aforementioned reason and its relation is closer to learning to use fuelup
than installing a testnet.
Here is the link to a section in beta-4
. This default
section ought to be removed.
Not sure how to create an epub export but happy attempting it if someone wants to point me in the right direction?
This is another todo/idea I've been putting off for almost a year that could be nice to have under a "Contributing" chapter (as proposed in #67).
I'm imagining something like the following:
gh
).cargo deps
command to generate a graphviz render like so.
cargo deps --optional-deps --filter forc parser sway-core sway-fmt sway-server sway-types sway-utils core_lang docstrings fuel-asm fuel-tx fuel-merkle fuel-storage fuel-core fuel-vm fuels-abigen-macro fuel-types fuel-gql-client fuels-abi-cli fuels-core fuels-rs fuel-pest fuel-pest_derive fuel-pest_generator fuel-pest_grammars fuel-pest_meta | dot -Tpng > graph.png
It would be cool if cargo deps
could output mermaid code that we could host in our markdown directly (with the mdbook-mermaid plugin) so that it renders a little nicer and matches the theme, but I'm not sure off the top of my head if it supports mermaid.
Here's a very old graphviz example I generated for forc
when I first started to better understand how it and its dependencies related to one another:
Thank you @kayagokalp - will update this after I get a chance to sync with @luizstacio
For reference: FuelLabs/forc-wallet#40
Sections of docs to be added: parallel transaction execution, utxo, state access lists, fraud proofs
looking at the documentation, putting the output of the command result is cumbersome if you press the copy button and paste it, they should apply this documentation method where the output is displayed
I believe the wallet is installable from the web-store since we have announced it a while back iirc.
Import https://github.com/FuelLabs/developer-quickstart into this repo, and include code directly using {{#include }}
blocks. Then add some CI to make sure the code actually compiles.
See e.g. the Sway book: https://github.com/FuelLabs/sway/blob/719dca1bd0ec8cc58e651d7327fb0e16276eb69e/docs/src/examples/subcurrency.md?plain=1#L8
Perhaps it could be useful to have a "Contributing" page where devs interested in contributing to Fuel (or new devs hired by Fuel) could get an overview of the Fuel repositories, which repos are relevant to which teams, how the PR process works, code review expectations, and so-on.
I know we have some internal notion docs on this, but it would be great to pull out what we can into the public so that external contributors can benefit too. I remember wanting something like this to help navigate the repos when first getting started, but never got around to writing something up. I'm just cleaning up some old notes from those times now and thought I'd open an issue!
Those links are now broken and should point to the new Book for the specs instead of the old *.md
files.
In this link , in the modify app section, the jsx highlighting it's not working
Current documentation uses the CLI wallet and hardcodes the wallet's secret.
Since Fuel Wallet is already out (as an alpha) should be included at least in the quickstart.
Add a Developer Guides section to Fuel book and port the following repos as guides:
Reported by @Rubyt0x
fuel-docs/src/developer-quickstart.md
Line 34 in d991c21
A declarative, efficient, and flexible JavaScript library for building user interfaces.
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google ❤️ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.