alexzbusko
commented
2 years ago Initial notes for Getting started and scaffolding pages (will continue tomorrow):
Notes on website docs testing/run through:
Overall structure notes:
- Requirements sections in plugins/other pages should be standardized with up to date info and in general should have all the same info present
General home page:
- Get started, docs and release notes are black on home page but switch to a yellow colour when in any of the docs sections (clicking on an option of those three)
-
Installation Page:
- We are
Introduction Page:
- Taquito plugin has link extending for an extra word
- "Taqueria is a task runner that you can use from the command line or the VS Code command palette" should this have the command palette part changed/updated? We are no longer just using the command palette
- Same thing as above with command palette under major components section: "A VS Code Extension which provides the ability to run Taqueria tasks from the command palette"
- https://taqueria.io/docs/intro/#taqueria-project has a line for the .taq folder but uses the `./` in front of the directory name, this should be changed to just `.taq/` to be consistent. The following note section is the same way
- https://taqueria.io/docs/intro/#taqueria-plugins needs to have metadata plugin entry added
Quickstart page:
- Requirements section on this page doesn't have a taq version, we should add one in for consistency
- https://taqueria.io/docs/getting-started/quickstart/#requirements mentions the command palette, we should change this wording to jsut mention VSCode extension
- https://taqueria.io/docs/getting-started/quickstart/#starting-a-taqueria-project using `./.taq` should just be `/.taq`
- https://taqueria.io/docs/getting-started/quickstart/#starting-a-flextesa-sandbox has some problem as above with `./.taq`
-
Scaffold basics:
- https://taqueria.io/docs/scaffolds/scaffold-basics/#building-and-starting-scaffolds has `npm run setup` twice, second one should be `npm run start`
- https://taqueria.io/docs/scaffolds/scaffold-basics/#available-scaffolds quickstart mentions a counter contract but scaffold doesn't have that. Likely should be part of the quickstart scaffold refactor
Taco shop scaffold:
- Spelling mistake in https://taqueria.io/docs/scaffolds/taco-shop/#quickstart "Immediatley"
- https://taqueria.io/docs/scaffolds/taco-shop/#overview has `available_tacos` but isn't formatted as code and should be for consistency
- https://taqueria.io/docs/scaffolds/taco-shop/#requirements has beacon or kukai wallet, later on we specifically call out temple so we should probably just tell people to have a temple wallet set up. There is also a faucet file requirement but that no longer exists. Will need to discuss what goes here
- https://taqueria.io/docs/scaffolds/taco-shop/#react-dapp this section has a note stating that the returned contract address must be inserted into the dApp but the section to do it https://taqueria.io/docs/scaffolds/taco-shop/#insert-the-contract-address-optional is listed optional. We should make this mandatory and put the two sections together
- https://taqueria.io/docs/scaffolds/taco-shop/#originate-to-the-testnet has a section on faucet files. Will need to be updated to reflect what we are moving to instead of faucet files
- Considering we originate to a testnet in this scaffold the test section seems unnecessary unless we have tests that are related to the taco shop
Quickstart project:
- No step to get user into directory, needs a `cd quickstart-project`
- Table specifies automated tests but the jest plugin is not installed, should be removed
- Requirements section should be moved up and use the format of other pages
- https://taqueria.io/docs/scaffolds/quickstart/#requirements has docker desktop listed but that is only for windows environments. We should probably have a note that it is only required for windows users
- There is a note in the requirements for not scaffolding from the vscode extension. That may no longer apply
- https://taqueria.io/docs/scaffolds/quickstart/#use-of-nodejs bad formatting for `/app`
- https://taqueria.io/docs/scaffolds/quickstart/#app-specific-settings should update the actual json files here, some differences are there
NFT Scaffold:
- No requirements section for what you need for the scaffold
- https://taqueria.io/docs/scaffolds/nft-scaffold/#project-setup should have a step before step 6 which gets user back to main project directory. Right now the start taqueria:local script won't work
hu3man
🔗 Epic|Feature Link
No response
🚥 Definition of Done
✅ To Do
No response
🔭 Scope
🏎️ In Scope:
Confirming all tasks documented have the correct and complete set of parameters and options documented
🙅♂️ Out of Scope:
🧰 Work Description
Taqueria has been undergoing rapid development and changes over the past couple of months. As such, the Docusaurus documentation is now out of date in places and needs to be reviewed and updated so it matches what our users will see with the current release, and correctly get's them through any processes with accurate code snippets and confirming that all the commands and steps listed work as expected
This is also a huge opportunity for additional manual testing of Taqueria which may uncover additional bugs or opportunities for improvement. These should be logged!
⚖️ Acceptance Criteria
📚 Documentation:
🖍 Review / Approvals:
🎢 Test Plan
No response
🎆 Release Notes
No response
🦄 Sizing
No response
Code of Conduct