permaweb / aos

An operating system for AO: The hyper parallel computer
https://ao.g8way.io
Other
68 stars 46 forks source link

Cookbook feedback #320

Open Jeremiahstockdale opened 1 month ago

Jeremiahstockdale commented 1 month ago

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

Jeremiahstockdale commented 1 month ago

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 commented 1 month ago

Yep, we have not released 2 yet once released we will update the get_ao under nameThxTomSent from my iPhoneOn Aug 8, 2024, at 12:54 PM, Jeremiah @.***> wrote: 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

—Reply to this email directly, view it on GitHub, or unsubscribe.You are receiving this because you are subscribed to this thread.Message ID: @.***>

hitwill commented 1 month ago

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 commented 4 weeks ago

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 commented 1 week ago

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?

hitwill commented 1 week ago

Links to some of autonomous finance's resources would also be very helpful: https://github.com/Autonomous-Finance/aos-packages/tree/main/packages https://github.com/Autonomous-Finance/ao-process-testing https://github.com/Autonomous-Finance/aoform

twilson63 commented 1 week ago

100%

@@. @.> @@. @.> @@. @.>

We should create a community guides section for

On Wed, Sep 4, 2024 at 12:58 AM SkyFoxx @.***> wrote:

Links to some of autonomous finance's resources would also be very helpful: https://github.com/Autonomous-Finance/aos-packages/tree/main/packages https://github.com/Autonomous-Finance/ao-process-testing https://github.com/Autonomous-Finance/aoform

— Reply to this email directly, view it on GitHub https://github.com/permaweb/aos/issues/320#issuecomment-2327921668, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAAFGLCOQU7RMC6NY2O5KM3ZU2HOXAVCNFSM6AAAAABMC7OFHGVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDGMRXHEZDCNRWHA . You are receiving this because you commented.Message ID: @.***>