Skip to content

Commit

Permalink
docs: package api doc (#1981)
Browse files Browse the repository at this point in the history
  • Loading branch information
pd93 authored Dec 31, 2024
1 parent 89740ed commit e5d8237
Show file tree
Hide file tree
Showing 4 changed files with 32 additions and 3 deletions.
2 changes: 1 addition & 1 deletion website/docs/reference/environment.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
slug: /reference/environment
sidebar_position: 4
sidebar_position: 5
---

# Environment Reference
Expand Down
29 changes: 29 additions & 0 deletions website/docs/reference/package.mdx
Original file line number Diff line number Diff line change
@@ -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).
2 changes: 1 addition & 1 deletion website/docs/reference/schema.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
slug: /reference/schema
sidebar_position: 2
sidebar_position: 3
toc_min_heading_level: 2
toc_max_heading_level: 5
---
Expand Down
2 changes: 1 addition & 1 deletion website/docs/reference/templating.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
slug: /reference/templating/
sidebar_position: 3
sidebar_position: 4
toc_min_heading_level: 2
toc_max_heading_level: 5
---
Expand Down

0 comments on commit e5d8237

Please sign in to comment.