docs: sync AGENTS.md boilerplate to the package template
Replaces the preamble with the current package-template text: adds the recipe-index paragraph and the New Package Checklist pointer, and drops the retired per-package TODO.md in favour of GitHub issues on the package repo.
This commit is contained in:
1 file changed
+17
-1
@@ -6,7 +6,23 @@ Develop it inside a StartOS packaging workspace created by `start-cli s9pk init-
|
|||||||
which provides the packaging guide and agent context one level up. If you're reading this in a
|
which provides the packaging guide and agent context one level up. If you're reading this in a
|
||||||
bare clone with no workspace, the full guide is at <https://docs.start9.com/packaging>.
|
bare clone with no workspace, the full guide is at <https://docs.start9.com/packaging>.
|
||||||
|
|
||||||
Work this package's `TODO.md` from top to bottom. Keep `README.md` (technical reference for an AI support or administering agent) and `instructions.md` (end-user docs) in sync with your changes.
|
**Start every task at the recipe index** — `../start-technologies/projects/start-sdk/docs/src/recipes.md`
|
||||||
|
(or <https://docs.start9.com/packaging/recipes.html>). It maps an intent ("prompt the user to create
|
||||||
|
admin credentials", "expose a web UI") to the constructs, the reference pages, and a named production
|
||||||
|
package to copy. Find the recipe before you read this package's neighbours: a package you reach by
|
||||||
|
grepping may be non-conformant, and the recipe outranks it.
|
||||||
|
|
||||||
|
Freshly scaffolded? Work the
|
||||||
|
[New Package Checklist](../start-technologies/projects/start-sdk/docs/src/new-package-checklist.md)
|
||||||
|
(or <https://docs.start9.com/packaging/new-package-checklist.html>) from top to bottom. It is a
|
||||||
|
guide page, not a file in this repo — read it, don't copy it in.
|
||||||
|
|
||||||
|
Keep `README.md` (technical reference for an AI support or administering agent) and
|
||||||
|
`instructions.md` (end-user docs) in sync with your changes.
|
||||||
|
|
||||||
|
**Bugs and feature requests are GitHub issues on this repo** — file them as you find them.
|
||||||
|
Don't record work in the repo instead: no `TODO.md`, no `NOTES.md`, no `PLAN.md`. What you
|
||||||
|
verified, tried, and decided belongs in the commit message and the PR body.
|
||||||
|
|
||||||
## This repo
|
## This repo
|
||||||
|
|
||||||
|
|||||||
Reference in new issue
Block a user