Skip to content

docs: сервер это контент курса, а не деталь реализации - #23

Merged
fey merged 1 commit into
mainfrom
docs/server-is-course-content
Sep 3, 2026
Merged

docs: сервер это контент курса, а не деталь реализации#23
fey merged 1 commit into
mainfrom
docs/server-is-course-content

Conversation

@fey

@fey fey commented Sep 3, 2026

Copy link
Copy Markdown
Contributor

README сообщал только команды, и по нему нельзя было понять, что за проект: на сервер живьём ходят студенты из четырёх курсов, а уроки и самостоятельные цитируют его ответы дословно, вплоть до значений полей. Теперь README называет проект, показывает устройство в три строки (TypeSpec → OpenAPI → fastify-openapi-glue) и отсылает к AGENTS.md до первой правки.

В AGENTS.md пять фактов, каждый из которых снаружи выглядит не тем, чем является:

  • значения полей только на латинице — сервер один на все локали курсов, и русский текст в ответе читался бы как ошибка у испанского студента;
  • дефолты skip: uint16 = 0 и limit: uint16 = 30 несут пагинацию — значение подставляет валидатор, и без них ломается только limit, что снаружи читается как «limit не поддерживается»;
  • make generate очищает custom-server/src/generated/ перед записью — неудачная проба сносит закоммиченное;
  • сервисы в тесте снимаются группой по PIDdetached: true плюс process.kill(-pid), потому что внук npx переживает SIGTERM обёртке, а pkill -f "fastify start" совпадает с текстом собственной команды и убивает свою же оболочку;
  • трейлинг-слеш даёт 404/postman/users/ не отвечает, и в текстах курсов адрес пишется без слеша.

Разметка новых абзацев по rumdl: абзац одной строкой, маркеры -. Пятьдесят одна находка MD013 и MD004, которые уже были в AGENTS.md, не тронута — это отдельный проход, иначе правка утонет в переформатировании.

🤖 Generated with Claude Code

README сообщал только команды, и по нему нельзя было понять, что на сервер
живьём ходят студенты и что уроки цитируют его ответы дословно. Теперь он
называет проект и отсылает к AGENTS.md до первой правки.

В AGENTS.md пять фактов, каждый из которых снаружи выглядит не тем, чем является:
значения полей только на латинице (сервер один на все локали курсов); дефолты
skip и limit несут пагинацию, и без них limit молча перестаёт работать;
make generate очищает generated/ перед записью; сервисы в тесте снимаются
группой по PID, потому что pkill -f совпадает с текстом своей же команды;
трейлинг-слеш даёт 404.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@fey
fey merged commit a7601f7 into main Sep 3, 2026
3 checks passed
@fey
fey deleted the docs/server-is-course-content branch September 3, 2026 16:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant