From 8618397bc15848fcad1339783428c44d07c11a1b Mon Sep 17 00:00:00 2001 From: ScuroNeko Date: Thu, 26 Mar 2026 18:35:35 +0300 Subject: [PATCH] wip: expand docs and wiki structure add wiki links to README and README_RU fill Start here pages for setup, commands/plugins, and MsgContext add wiki page-priority tracker and local wiki AGENTS rules --- .gitignore | 1 + AGENTS.md | 10 ++++++++++ CHANGELOG.md | 5 +++++ README.md | 4 ++++ README_RU.md | 4 ++++ 5 files changed, 24 insertions(+) diff --git a/.gitignore b/.gitignore index f26b8e6..3baab3b 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,3 @@ .idea/ test/ +.wiki/ diff --git a/AGENTS.md b/AGENTS.md index a1af97c..c40597f 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -100,6 +100,16 @@ Prefer the repository’s documented commands. If multiple choices exist, use th - Prefer additive compatibility over signature changes when the additive option is small and maintainable. - Example: if a method like `ctx.answer(...)` needs an extra parameter, the agent must either require a major-version bump or add a new method that keeps the old method working. +## Commit message format +- When the user asks for a commit message, the agent must produce it in this format: + 1. a short summary line; + 2. up to three additional lines with only the most important changes; + 3. each additional line must start on its own new line. +- The agent must output the commit message as a plain multiline block that the user can copy directly. +- Do not collapse the lines into a paragraph, bullet list, or wrapped prose explanation. +- Keep commit text concise and high-signal. +- Do not turn commit messages into changelogs. + ## Output format For repo-wide review tasks, structure the result as: diff --git a/CHANGELOG.md b/CHANGELOG.md index a4a826e..ae5b957 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -10,8 +10,13 @@ ### Changed - `CommandExecutor` now returns `error`, and command, payload, and non-command update handlers now use centralized bot error handling for returned errors. - README and README_RU examples now use the new handler signature and document the long-message helpers. +- README and README_RU now link to the project wiki, and the wiki now includes a page-priority tracker while content is being filled in. - `AGENTS.md` now requires every change to be recorded in `CHANGELOG.md`, enforces version alignment with `utils/version.go`, and blocks breaking changes without a major-version bump. +- `AGENTS.md` now also defines a short commit-message format: one summary line plus up to three high-signal detail lines. +- `AGENTS.md` now explicitly requires each commit-message detail line to be placed on its own new line. +- `AGENTS.md` now also requires commit messages to be emitted as a plain multiline block instead of collapsed prose or list formatting. - Payload-type comments and docs now distinguish between the bot's default payload type and keyboard-local overrides. +- The wiki `Start here` section now has substantive first-pass documentation for setup, commands/plugins, and `MsgContext`. - Version constants were bumped to `v1.0.0-rc.12`. ### Fixed diff --git a/README.md b/README.md index 501e882..2350721 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,8 @@ A lightweight, easy-to-use, and performant Telegram Bot API wrapper for Go. It s [На русском](README_RU.md) +[Wiki](https://git.nix13.pw/ScuroNeko/Laniakea/wiki) + --- ## ✨ Features @@ -247,6 +249,8 @@ This project is licensed under the GNU General Public License v3.0 — see the [ ## 📚 Learn More [GoDoc](https://pkg.go.dev/git.nix13.pw/scuroneko/laniakea) +[Wiki](https://git.nix13.pw/ScuroNeko/Laniakea/wiki) + [Telegram Bot API](https://core.telegram.org/bots/api) ✅ Built with ❤️ by scuroneko diff --git a/README_RU.md b/README_RU.md index 85579d6..dbefd88 100644 --- a/README_RU.md +++ b/README_RU.md @@ -10,6 +10,8 @@ [English](README.md) +[Wiki](https://git.nix13.pw/ScuroNeko/Laniakea/wiki) + --- ## ✨ Возможности @@ -243,6 +245,8 @@ func adminOnlyMiddleware(ctx *laniakea.MsgContext, db *MyDB) bool { ## 📚 Дополнительная информация [GoDoc Laniakea](https://pkg.go.dev/git.nix13.pw/scuroneko/laniakea) +[Wiki](https://git.nix13.pw/ScuroNeko/Laniakea/wiki) + [Telegram Bot API](https://core.telegram.org/bots/api) ✅ Создано с ❤️ scuroneko