Skip to content

Commit d2458ae

Browse files
committed
Simplify the folder structure as it's a flat documentation repo
1 parent fdcd80b commit d2458ae

File tree

10 files changed

+17
-27
lines changed

10 files changed

+17
-27
lines changed

README.md

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,26 @@
33
A Taskfile adds a list of commonly used tasks in a quick overview in your CLI. Enable your users to quickly setup a
44
project and run common tasks via super simple commands.
55

6-
![CLI Taskfile preview](./docs/images/cli-preview.gif)
6+
![CLI Taskfile preview](./images/cli-preview.gif)
77

88
## Create your own taskfile
99

1010
This project gives you a `Taskfile` base, and gives you a collection of usefull tasks to help out on your project.
1111

12-
- [What is a Taskfile](docs/what-is-a-taskfile.md)
13-
- [The Taskfile base](docs/base.md)
14-
- [Usefull tasks](docs/usefull-tasks.md)
12+
- [The Taskfile base](./taskfile-base.md)
13+
14+
We strongly recommend that your project uses a project section containing a `init` and a `update` task. Check out our
15+
example:
16+
17+
- [Project section](./section/project.md)
18+
19+
## Usefull tasks
20+
21+
Check out the following sections for tasks that could be helpfull for your project's Taskfile:
22+
23+
- [Docker](./section/docker.md)
24+
- [GitHub](./section/github.md)
25+
- [GitLab](./section/gitlab.md)
1526

1627
## Credits
1728

bin/task

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ set -eo pipefail
33

44
# =========================================================
55
# Taskfile gives you a set of quick tasks for your project
6-
# More info: https://bit.ly/taskfile-base
6+
# More info: https://go.futureportal.com/taskfile
77
# =========================================================
88

99
CURRENT_DIR=$(pwd)

docs/usefull-tasks.md

Lines changed: 0 additions & 14 deletions
This file was deleted.

docs/what-is-a-taskfile.md

Lines changed: 0 additions & 5 deletions
This file was deleted.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

docs/base.md renamed to taskfile-base.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
[Overview](../README.md) ➤ Taskfile base
2-
31
# The Taskfile base
42

53
Below is the Taskfile base we recommend you use. Below we will explain what sections are in the base and why.
@@ -98,4 +96,4 @@ your system, so you can use `task <task>` in the future. It will look for a `Tas
9896

9997
# Adding relevant tasks
10098

101-
Relevant tasks for your project can be found in [the tasks overview](./usefull-tasks.md).
99+
Relevant tasks for your project can be found in [the tasks overview](./README.md#usefull-tasks).

0 commit comments

Comments
 (0)