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

Write tutorial #28

Closed
ll-nick opened this issue Jul 10, 2024 · 2 comments · Fixed by #51
Closed

Write tutorial #28

ll-nick opened this issue Jul 10, 2024 · 2 comments · Fixed by #51
Assignees
Labels
demo Concerns the project's demonstration documentation Improvements or additions to documentation

Comments

@ll-nick
Copy link
Collaborator

ll-nick commented Jul 10, 2024

With large parts of the demo in place, we can also think about how we want to present it in form of a tutorial. We need some form of readme or presentation guiding a user through creating the arbitration graph.

@ll-nick ll-nick added documentation Improvements or additions to documentation demo Concerns the project's demonstration labels Jul 22, 2024
@ll-nick
Copy link
Collaborator Author

ll-nick commented Oct 8, 2024

Brainstorming Session

  1. "Theory": What to find where in the repo? What is the goal of the tutorial?
  2. Starting point: Tutorial branch with PacmanAgent with random walk and avoid ghost behaviors, no verifiers
  3. Task: Finish chase ghost finish so that is passes unit tests by re-implementing some removed part, e.g. getCommand
  4. Task: Integrate chase ghost into priority arbitrator
  5. Task: Integrate eat closest dot behavior
  6. Task: Integrate eat dot arbitrator as random arbitrator
  7. Task: Replace arbitrator from previous step with cost arbitrator, finish cost estimator

General: Add a bit of an explanation about arbitration graphs to top-level readme

Technical Details

  • One markdown file per step
  • Copy task and solution code snippets into tutorial
  • "Theory" page is landing page for tutorial, tasks are linked from there

@ll-nick
Copy link
Collaborator Author

ll-nick commented Oct 24, 2024

We did forget about a slight detail, the verification 😅

I'll add that as the last task.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
demo Concerns the project's demonstration documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant