From bb87318da8b24ce9b16ef70f90261a341d8ad948 Mon Sep 17 00:00:00 2001 From: Pete Davison Date: Tue, 31 Dec 2024 15:40:07 +0000 Subject: [PATCH] feat: package api doc --- website/docs/reference/environment.mdx | 2 +- website/docs/reference/package.mdx | 29 ++++++++++++++++++++++++++ website/docs/reference/schema.mdx | 2 +- website/docs/reference/templating.mdx | 2 +- 4 files changed, 32 insertions(+), 3 deletions(-) create mode 100644 website/docs/reference/package.mdx diff --git a/website/docs/reference/environment.mdx b/website/docs/reference/environment.mdx index 40ccfb6344..d6772620c6 100644 --- a/website/docs/reference/environment.mdx +++ b/website/docs/reference/environment.mdx @@ -1,6 +1,6 @@ --- slug: /reference/environment -sidebar_position: 4 +sidebar_position: 5 --- # Environment Reference diff --git a/website/docs/reference/package.mdx b/website/docs/reference/package.mdx new file mode 100644 index 0000000000..1f753897ab --- /dev/null +++ b/website/docs/reference/package.mdx @@ -0,0 +1,29 @@ +--- +slug: /reference/package +sidebar_position: 2 +--- + +# Package API + +:::warning + +**_Task's package API is still experimental and subject to breaking changes._** + +This means that unlike our CLI, we may make breaking changes to the package API +in minor (or even patch) releases. We try to avoid this when possible, but it +may be necessary in order to improve the overall design of the package API. + +In the future we may stabilize the package API. However, this is not currently +planned. For now, if you need to use Task as a Go package, we recommend pinning +the version in your `go.mod` file. Where possible we will try to include a +changelog entry for breaking changes to the package API. + +::: + +Task is primarily a CLI tool that is agnostic of any programming language. +However, it is written in Go and therefore can also be used as a Go package too. +This can be useful if you are already using Go in your project and you need to +extend Task's functionality in some way. + +The full generated documentation for the package API is available on +[pkg.go.dev](https://pkg.go.dev/github.com/go-task/task/v3). diff --git a/website/docs/reference/schema.mdx b/website/docs/reference/schema.mdx index d79e31624e..29dc58c858 100644 --- a/website/docs/reference/schema.mdx +++ b/website/docs/reference/schema.mdx @@ -1,6 +1,6 @@ --- slug: /reference/schema -sidebar_position: 2 +sidebar_position: 3 toc_min_heading_level: 2 toc_max_heading_level: 5 --- diff --git a/website/docs/reference/templating.mdx b/website/docs/reference/templating.mdx index 63321756fa..98d45bae00 100644 --- a/website/docs/reference/templating.mdx +++ b/website/docs/reference/templating.mdx @@ -1,6 +1,6 @@ --- slug: /reference/templating/ -sidebar_position: 3 +sidebar_position: 4 toc_min_heading_level: 2 toc_max_heading_level: 5 ---