Giter Club home page Giter Club logo

fuel-docs's Introduction

Fuel Docs

⚠️ Archived

Docs are now maintained at https://github.com/FuelLabs/docs-hub

Building From Source

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

fuel-docs's People

Contributors

adlerjohn avatar arboleya avatar calldelegation avatar camiinthisthang avatar canibal avatar cold-briu avatar controlcpluscontrolv avatar dabit3 avatar edakturk14 avatar joshuabatty avatar k1-r1 avatar mehtavishwa30 avatar mitchmindtree avatar mohammadfawaz avatar rubyt0x avatar sandoche avatar sarahschwartz avatar simonr0204 avatar theekrystallee avatar voxelot avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

fuel-docs's Issues

Request for additional docs on Addresses

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)?

Example Smart Contracts: out of date

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.

Testnets and setting a default fuelup version

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.

Introduce a graphviz of the Fuel Labs ecosystem crates

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:

  • Create a small script that scans the FuelLabs github org repos for all crate names (e.g. using gh).
  • Use collected crate names with the 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
  • Run the script under a daily cron-job workflow that automatically generates and hosts the image under a gh-pages URL.
  • Link to the visualisation in the “Contributing” chapter.

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:

graph

Add a Contributing page to the Developers chapter?

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!

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.