Lack of documentation for Burner
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 13
- Forks
- 81
- PR merge metrics
- No merged PRs in 30d
Description
Reported by: Brian Doyle (<@brian.doyle>)
Issue Description:
Someone want to know how to emit a Destroy event for Flow NFT, but there is none in our example code.
@Joshua
@brian.doyle
I had to introduce flow-ft and the burner contract, and explain how to add a burner to Flow NFT
I searched in our documents, and there is no documented introduction to Burner and its related mechanisms.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
No file, test, or entry point is named. Start by reviewing the existing Flow NFT documentation and example code, then document Burner, its related mechanisms, and how to add a burner to Flow NFT; done means users can understand and follow the Burner introduction and emit a Destroy event.
Written by the indexing model from the issue text.
Assessment
- Domain
- blockchain, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100