Skip to content

Improved documentation #9

@Crystalflxme

Description

@Crystalflxme

Describe the feature

The docs, most notably the docs for Chain, need heavily revised to be more clear and resourceful. Ideally, you should be able to read the docs and not only conceptually understand the system, but also be able to use it on a technical basis. They should also serve as a reference while working.

Additionally, the docs for ChainLink need better connections to the docs for Chain, especially as there are inaccuracies in the ChainLink docs that reference the pre-refactor version from #8.

Additional context

At the moment, the Chain docs direct people to read the source code as the primary method of learning the specifics, and this is unideal.

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions