Skip to content

[Documentation] Set Up GitHub Wiki for Keylabs Documentation #40

Description

@AntGa

Problem
Currently, Keylabs lacks a structured and accessible documentation system. To help users and (possible future) contributors better understand the project, we need to set up some documentation. For this using GitHub's Wiki feature would be suitable. This will enhance the onboarding experience and provide clear guidance for contributors.

Objectives

  • Create and organize the GitHub Wiki with key sections like:
  • Home Page: Project overview and links to key sections.
  • Getting Started: Detailed setup instructions for both developers and users.
  • Gameplay Features: Breakdown of game mechanics, leaderboards, and experience system.
  • Contributing Guide: Steps and guidelines for contributing to Keylabs.
  • API Documentation (if applicable): Overview of any API endpoints.

Acceptance Criteria

  • The GitHub Wiki is set up with an organized structure.
  • Key sections are drafted and include sufficient information for users and contributors.
  • Wiki links added to the README.md for easy navigation.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions