Skip to content

Improve documentation #1

Open
Open

Description

@asterdoescomputing

There is need to improve the documentation, especially for the instructions on how to set up the application. It should be made;

  • Simplified
  • Easy to understand
  • And much more clearer

Information on how the application works may also be removed summarised!

Activity

  1. uNikhil-codes commented on May 24, 2026

    @uNikhil-codes

    Hi @asher-not-king, I would like to work on improving the documentation for this project.

    My plan is to:

    • simplify the setup instructions
    • improve readability and structure
    • make onboarding easier for new contributors/users
    • summarize complex sections where needed

    I’ll make sure the updated documentation remains concise, beginner-friendly, and easy to follow.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationgood first issueGood for newcomers

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions