onflow / onflow/docs

Common Errors Documentation

Open
#707 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

Issue:
There are common errors that people repeatedly face which are not chronicled anywhere. The lack of sources for resolving these means that the popular KAPA AI tool is less effective in guiding developers through trouble shooting their code. Usage of KAPA indicates that a very common workflow for developers is copying and pasting errors directly into the chatbot expecting to get a resolution, creating a document with common errors and solutions would help mitigate these challenges.

  • Create a document with common errors
  • Improve Human Readable Definition/Information for TOP Errors here
  • Add suggested messaging to show to users when the protocol gives back these errors
  • Improve Human Readable Definition/Information for ALL Errors here
  • Add suggested solutions to help mitigate or resolve these errors
  • Gain access from Ali to KAPA AI, look through last 6 months of data gathering all the most common errors people tried to resolve. Compile in same doc the most commonly reported errors in discord thorugh SIFT. Write out detailed solutions and answers for each. This doc will be fed into KAPA as a data source then tested for accuracy and compiled in a resource on the docs site.

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

Review the existing error-code document at https://developers.flow.com/tools/error-codes and the unchecked checklist items in this issue. Determine which error definitions, messages, solutions, and KAPA data work are in scope; done would require completing the selected documentation tasks and validating the resulting resource.

Written by the indexing model from the issue text.

Assessment

Domain
blockchain, 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.