GDQuest / godot-steering-ai-framework

A complete framework for Godot to create beautiful and complex AI motion. Works both in 2D and in 3D.

Home Page:http://gdquest.com/docs/godot-steering-ai-framework

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Write the getting started documentation

Razoric480 opened this issue · comments

The quick-start documentation and user's guide needs to be written up to reach the MVP stage. The docstring for the classes could also use some improvement.

Once François is done with that, @johnnygossdev, could you do the editing? Proofing and refining the text.

In general, let's work like that for writing: instead of doing review rounds, we can be more efficient working like professional writers. One writer, one or two editors.

In case you've not done it before:

  1. The writer writes the content in one or two passes, until it's ready for review
  2. Then hands it to the editor, who makes edits. Proofing, fixing typos, rephrasing. Here's an example: godotengine/godot-docs@dcb9cb4
  3. If any key information is missing, or requires the writer's expertise, the editor sends the document back for another loop.

It's simple, but also much more efficient than doing reviews as we do in code.

Yep not a problem! 👍