Skip to content

Add more examples and use-cases in the documentation #2697

@ilovelinux

Description

@ilovelinux

Description

Note

This issue is based on my experience.

Context

I was looking for a tool for a personal use-case and I found Task. It looks maintained and well documented, however...

Issue

... I am having some hard time understanding:

  • What does it do.
  • Why has it been created.
  • Which problems does it solve.
  • Which are the perfect use-cases.
  • Which are the limitations.

Main pages on docs doesn't answer to those questions, neither the FAQ does. There are a few examples on Getting Started but they are very simple.

In fact, the only explanation about "what is Task" is in the website's homepage:

A fast, cross-platform build tool inspired by Make, designed for modern workflows.

But I have no idea about the advantages using Task instead of Make for "modern workflows".

Consequence

As now:

  • It's not clear to me whether Task fulfill my needs or not.
  • I'm not willing to spend time trying it, understanding how it works and its limitations.

So I'm not going to use Task:
Because it doesn't fulfill my needs
✔️ Because Task advantages, use-cases and limitations, aren't clear to me

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions