onflow / onflow/docs

Update Tools Section

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

### Tasks
- [ ] Tools/Flow Emulator, instead of pointing externally for installation and usage, directly include steps to install CLI, start emulator with Flow emulator, checkout a network and simulate a transaction.
- [ ] Tools/Flow Go SDK/ → update image to work with darkmode.
- [ ] Tools/Flow SDK for Unity/ Remove Changelog and Licence, these better live on the SDK’s site or repo than the dev docs.
- [ ] - Flatten the Tools/Flow SDK for Unity/Guides folder.     - Rename Dev Wallet → Unity Dev Wallet (to avoid confusion with other docs)     - Rename Wallet Connect → Unity Wallet Connect.
- [ ] Tools/Flow SDK for Unity/Samples → rename samples to guides.
- [ ] Tools/Flow Javascript Testing/ JS Testing API Reference → Move Required into an info bubble.
- [ ] Tools/Flow Javascript Testing/ Contracts → Move Required into an info bubble.
- [ ] Tools/Flow Javascript Testing/ JS Testing API Reference → Fix grammar in intro sentences.
- [ ] Tools/Flow Javascript Testing/examples → includes an empty ‘basic’ doc, Additional examples only includes one example. Remove the entire folder and its contents except for Additional Examples, move to parent director and rename it to Metadata. Also fix grammar (missing articles) and language to be less theoretical and more consistent with the rest of the docs.
- [ ] Tools/Flow Javascript Testing/ Execute Scripts → Move both ‘Required’ into an info bubble. Also make more clear, it’s confusing what the ‘following functions are’. Similar to the other todos in the Flow Javascript Testing, fix grammatical issues and tone
- [ ] Tools/Flow Javascript Testing/ Bootstrap Framework → Move ‘Required’ into an info bubble and fix grammar/tone.
- [ ] Tools/Flow Javascript Testing/ Init → Fx grammar/tone. It is also confusing calling it both an Init framework and method.
- [ ] Tools/Flow Javascript Testing/ Install Flow Javascript Testing Framework → Move ‘Required’ into an info bubble and fix grammar/tone.
- [ ] Tools/Flow Javascript Testing/ Send Transactions → Move ‘Required’ into an info bubble and fix grammar/tone. Change intro to assume that the reader is landing on the page and not continuing from previous, i.e. change ‘Another common case’ to improve modularity of the doc.
- [ ] Tools/Flow Javascript Testing/ Folder Structure → References Framework but not clear what it’s referring to as there are multiple frameworks throughout the Flow Javascript Testing docs. Improve grammar and readability, especially for headers in the Usage section.
- [ ] - Tools/NFT Catalog →     - Under Developer Usage do not link out to another doc for installing Node or the Flow CLI, include the commands directly in the doc. Minimizing the amount of external clicks improves UX.     - Remove Licence section.     - Remove Live Site section, instead link in intro sentence to ‘NFT Catalog’.     - Add hyperlink to NFTCatalog.cdc and NFTRetrivial.cdc

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 reviewing the Tools/Flow Emulator, Flow Go SDK, Flow SDK for Unity, Flow Javascript Testing, and NFT Catalog sections named in the task list. Work through the listed page moves, renames, grammar, links, images, and installation instructions, checking each task as it is completed. Done means all checklist items are addressed across the documentation.

Written by the indexing model from the issue text.

Assessment

Tech stack
blockchain, go, javascript, nodejs, unity
Domain
blockchain, documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.