Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs - FAQ documents for developers. #28

Open
vuvoth opened this issue Apr 15, 2022 · 8 comments
Open

Docs - FAQ documents for developers. #28

vuvoth opened this issue Apr 15, 2022 · 8 comments

Comments

@vuvoth
Copy link

vuvoth commented Apr 15, 2022

We have a lot of common problems. We ask our questions on Discord server and received the answer. (Algorand team very friendly ❤️ )
Could we should create FAQ section and save our common mistakes? I think this is useful for questioner and respondent.

@barnjamin
Copy link
Contributor

Definitely needed. Lets try to collect some here?

@vuvoth
Copy link
Author

vuvoth commented Apr 15, 2022

My suggestion:

  • Overspend account error when create transaction.
  • Forgot add foreign assets, applications.
  • Doesn't opt in to assets or applications.

@dist1ll
Copy link

dist1ll commented Apr 17, 2022

  • What is the maximum X? Solved by looking at the Algorand parameter tables

  • How do I debug smart contracts? (this one I'm not sure, because the first google result gives you an answer)

@FrankSzendzielarz
Copy link

FrankSzendzielarz commented Apr 19, 2022

Short JSON names for raw transactions and related entities vs the long names used everywhere else - the API specs just show "object" for a Transaction in Algod POST. Took a while to figure out that the SDK Transaction/Account/etc class is different from the Algod or Indexer Model classes because of serialisation methods

@emg110
Copy link

emg110 commented Apr 19, 2022

I started to create one and had a similar exact proposition before the ETHDenver which was canceled due to me getting Covid and then came ETHDenver. I can certainly participate if you are interested and actually have gone some major steps of the way. Actually, I was thinking of an ElasticSearch Instance containing all the FAQs and answered as JSON objects in indices for different major categories.

@emg110
Copy link

emg110 commented Apr 19, 2022

The plan was to extract Algo Discord channels into ES Cloud indices and then use some lightweight ML Processing over them to classify them and have a structured semantics system and dictionaries as well. There is an Algorand treasure buried in data inside Discord servers. Hours of precious QA from heroes like JSON, JJ, Beni, Nullun and other community members is there.

@emg110
Copy link

emg110 commented Apr 19, 2022

That even can go further to a continuously running process of insights and content generation with ultimate search which sees what Devs are looking for (demand on discord) and actually parameterized itself to produce optimized FAQ content based on those priorities in real-time. Just what I had in mind. Pardon, if it got long.

@fionnachan
Copy link

FAQs would be super useful!! Here are some ideas:

  • opcode budget overspend workarounds
  • can a group tx only consist of one tx?
  • how to set up e2e tests for Algorand smart contracts
  • how do you choose between writing a smartsig or a smart contract?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

6 participants