Docs Improvements

[aurbano]

Main website

• Workshops: parse github to get the list of games (add a game.json file to game servers) + icon
• Workshops: add link to write your own
• Past events: keep + try to add the missing ones (it’s missing the intern challenge event from 2018)
• Add link to docs to main website

Docs

• Landing page: “who are you”, with three categories:

  • Participant
    • Before you arrive
    • Game rules
    • Cloning starter project (shared – see if we can generate blocks)
    • Running practice mode (shared) see if gitbook allows conditional blocks? (language used for example)
    • Writing your own logic
  • Mentor for an event
    • Game rules
    • Some tips, read the troubleshooting pages
  • Organiser for an event
    • Architecture overview (same as the developer contributing page)
    • Running the platform

• Hosted vs cloud vs laptop on premises

  • If hosted, what to download/onboard and how to run, which is the same as cloud
  • If cloud, maybe have a guide for heroku
  • Explore zeit.co
    • On the day

• Project on the screen

• Run stuff, give url to participants

• Setup lobbies

• Different tournament modes

  • Developer adding games
    • Explain the game server concept
    • JS vs Python vs Other languages

• Game server protocol

  • Uabc changes to support this game for practice mode

  • UI for this game (log analysis, and eventually real time during tournaments)

  • Developer contributing to the platform – link to the repos and to the issues page prefiltering with a label “help wanted” or “good first issue” (ideally use both)

    • UI
    • Tournament Server
    • Game Server
    • Repo naming conventions

• Add table of contents to docs

• Look for plugin to display a list of repos (ideally the results of a search) perhaps even write our own?

  • And for now manually link to example repos when talking about them

Each Repo on Github

• Show architecture image (same url on all repos so it stays up to date), and say below where in the architecture this fits.
  • Link to architecture page in docs
• Description of what it is and does
• How to install/run “prod”/”pre built” version
• If easy, a deploy section? (heroku, or zeit)
• Contributing Code
  • How to run dev version locally to make changes and see them
  • Testing???
• Debugging

Consistent naming for all repos

• Game Engines:
  {game name}-engine-{language}

• Game Server Libraries:
  game-server-{language}

• Game Servers:
  {game name}-game-server

• Starter Players:
  {game name}-player-{language}