readme-maintainer

name	readme-maintainer
description	Update this repository's README so it matches the current implemented scope. Use when the user asks to create, rewrite, or refresh README content, document new features, update setup or deployment instructions, or keep the README in sync with current code, configuration, Docker deployment, Raspberry Pi behavior, or project limitations.

README Maintainer

Use this skill when editing README.md for this repository.

Core Rules

1. Keep the README in Korean.
2. Document only what is already implemented or explicitly decided.
3. Do not write speculative roadmap content as if it already exists.
4. Treat the README as a living document that will be updated whenever features change.

Workflow

1. Read the current implementation before editing the README.
2. Prefer the codebase over memory.
3. Update only the sections affected by the current change unless the user asks for a broader rewrite.
4. Keep the wording concrete and operational.

What To Reflect

When relevant, check and update:

• project purpose
• current implemented scope
• major directory structure
• configuration and required environment variables
• local run commands
• proto generation commands
• Raspberry Pi deployment flow
• current limitations or assumptions
• guest authentication, role-based allowlist, session lifetime, and rate limit
• AI request format, history policy, and external AI server dependency
• latest Flyway migrations, including removals and nullable-field changes
• OpenAPI package structure, documented endpoint summary, and Redis access toggle
• Redis Lua scripts and the configuration values that control them

Repository-Specific Rules

1. Keep examples neutral.
   • Do not leave personal usernames or machine-specific values in examples unless the user explicitly wants them.
   • Prefer values like pi, 192.168.0.10, or placeholder-style examples when documenting deploy settings.
2. Keep deployment documentation aligned with the real repository flow.
   • Inspect the current deploy scripts and Compose files before describing image build or runtime location.
   • Do not claim a developer-machine build, Pi-local build, registry flow, or other deployment topology unless it is represented by the repository or explicitly decided by the user.
3. Keep sensor details aligned with the current code.
   • If BME680 config, I2C path, or address handling changes, update the README sections that describe them.
4. Respect the current stage of the project.
   • If the project is incomplete, say so explicitly instead of making the README sound finished.

Editing Notes

1. Prefer short sections over long explanations.
2. Keep command examples executable.
3. When showing config examples, match application.yaml, .env, and deploy scripts as they exist now.
4. If terminal output looks garbled because of encoding, do not assume the README must be rewritten in English. Keep the README itself in Korean unless the user says otherwise.
5. Use Mermaid only for implemented architecture, data, authentication, or external-integration flows. Do not add diagrams for speculative roadmap items.
6. Before finishing, verify README endpoint names, environment variables, migration versions, resource paths, and commands against the current repository.