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

Cookbook feedback #320

Open
Jeremiahstockdale opened this issue Aug 6, 2024 · 9 comments
Open

Cookbook feedback #320

Jeremiahstockdale opened this issue Aug 6, 2024 · 9 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@Jeremiahstockdale
Copy link
Contributor

provide feeback on the cookbook, what could be more clear? are there obvious errors? etc.

@Jeremiahstockdale Jeremiahstockdale added the documentation Improvements or additions to documentation label Aug 6, 2024
@Jeremiahstockdale Jeremiahstockdale self-assigned this Aug 6, 2024
@Jeremiahstockdale
Copy link
Contributor Author

Jeremiahstockdale commented Aug 8, 2024

https://cookbook_ao.g8way.io/tutorials/bots-and-games/ao-effect.html

1.Install aos Fire up your terminal and run:

bash
npm i -g https://get_ao.g8way.io

seems to be outdated because of aos 2.0

https://cookbook_ao.g8way.io/guides/aos/installing.html same as above

@twilson63
Copy link
Collaborator

twilson63 commented Aug 9, 2024 via email

@hitwill
Copy link

hitwill commented Aug 14, 2024

It's improved since you added a search but additionally:

  1. It could use a references section. Some of the information under guide should be reference. E.g. .load, Modules
  2. The blueprints have deprecated code. E.g. token blueprint. Instead of trying to keep it updated, you can just link to the git references
  3. For gold, you can consider something with version management like docusaurus. The problem is that you have:

This is hard to keep up with for devs and hard for you guys to maintain. If you can have them versioned, then devs can easily follow and give you better feedback.

You could even set up a bounty to get docusaurus (or similar) up and running, and updated

@dpshade22
Copy link

dpshade22 commented Aug 16, 2024

I agree that versioning the documents would be a significant improvement.

Even a last updated, or "as of AOS 2.X" on each page would be a great improvement.

My devX has been hindered by not being confident that the documentation I'm using is correct, especially given there are copies on Arweave that aren't up to date: https://ao_docs.ar.io/

@hitwill
Copy link

hitwill commented Sep 1, 2024

Another thing is that documentation on Spawning needs more information.
Spawning a process

It doesn't tell us what exactly a spawned process is. It tells you how to spawn a process but not what a spawned process is.

Is it a copy of the original process?

Can a spawned process' handlers be updated?

What situations are useful for spawned processes?

@twilson63
Copy link
Collaborator

twilson63 commented Sep 4, 2024 via email

@twilson63
Copy link
Collaborator

All these suggestions are great! We are a small team!

Contributions to the cookbook are welcome!

https://github.com/permaweb/ao-cookbook

🙏

@hitwill
Copy link

hitwill commented Sep 28, 2024

@twilson63 raised an issue here permaweb/ao-cookbook#231 (to start) and would like to push a pr, but the repo doesn't accept pushes or PR

fatal: unable to access 'https://github.com/permaweb/ao-cookbook/'

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

No branches or pull requests

4 participants