Skip to content

Conversation

pd93
Copy link
Member

@pd93 pd93 commented Feb 23, 2025

As mentioned in #2011 (review), the getting started docs could do with a bit of an overhaul. The usage page has slowly grown and become a bit daunting to a new user. It also doesn't mention --init in any capacity.

This PR solves both of these by adding a new Getting Started page to the website. This page is written more as a tutorial than a reference which is friendlier to new users. It instructs the user how to create a new Taskfile using --init, how to call it and how to write a basic build task.

Copy link
Member

@andreynering andreynering left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's a great idea!

In theory we could consider adding this page to the top bar, but I don't want to pollute it with too many items.

Screenshot 2025-02-23 at 14 06 45

I propose that we at least add a mention on the home, near where we already link the usage page.

Screenshot 2025-02-23 at 14 09 00

@andreynering andreynering added the area: docs Changes related to documentation. label Feb 23, 2025
@pd93
Copy link
Member Author

pd93 commented Feb 23, 2025

That's a great idea!

In theory we could consider adding this page to the top bar, but I don't want to pollute it with too many items.

Yeah, I think that most users will find it from the sidebar once they're in the docs section anyway.

I propose that we at least add a mention on the home, near where we already link the usage page.

I hadn't looked at the home page at all, but I agree. I would actually suggest replacing the example Taskfile we have there as this sort of duplicates some of the getting started. Something like this (pushed):

image

Copy link
Member

@andreynering andreynering left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good!

@pd93 pd93 merged commit 6f80777 into main Feb 23, 2025
14 checks passed
@pd93 pd93 deleted the getting-started-docs branch February 23, 2025 17:56
pd93 added a commit that referenced this pull request Feb 23, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: docs Changes related to documentation.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants