onflow / onflow/docs

Effective Cadence

Open
#708 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
13
Forks
81
PR merge metrics
No merged PRs in 30d

Description

Inspired by this thread. Goal is to have an official Cadence ebook, single-page HTML file that is easy to search modlled after Effective Go and the Cadence Language Reference.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading the Effective Go and Cadence Language Reference links cited in the issue, then review the existing Flow Developer Portal structure. Define the scope and content for an official Cadence ebook as a searchable single-page HTML document; done means that the agreed material is published in that form.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.