ggtracker / ggtracker/sc2reader

Adding new tutorial/quickstart content

Open
#67 3 comments 4 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

question
Dominant language
Python
Stars
169
Forks
152
PR merge metrics
No merged PRs in 30d

Description

@miguelgondu wrote this fantastic tutorial on using sc2reader

https://miguelgondu.github.io/python/ai/video%20games/2018/09/04/a-tutorial-on-sc2reader-events-and-units.html

I want to integrate this more directly into the documentation around, but I'm not quite sure where to wedge it in amongst the README, GitHub wiki, docs, etc.

What do you guys think?

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Read the linked sc2reader tutorial, then review the existing README, GitHub wiki, and docs to understand how documentation is organized. The work is done when the project has an agreed location for the tutorial content and the relevant documentation is updated there.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.