Refine AGENTS.md guidance
User description
- Add concise architecture summary for geoip2, realip, ipinfo configs
- Inline nginx-only note into overview for clearer scope
- Note quick nginx -t check and that GeoLite2 updates require rebuild
GitHub Copilot Summary:
This pull request updates the
AGENTS.mddocumentation to clarify the architecture and operational details of theipinfo.twproject. The changes improve the explanation of how nginx is used to serve IP information, provide a more complete overview of configuration files, and offer additional tips for building and maintaining the service.Architecture and configuration documentation improvements:
- Expanded the project overview to specify that all functionality is configured via nginx directives, with no application code layer.
- Added a dedicated architecture section describing the roles of key nginx configuration files (
geoip2.conf,realip.conf, andipinfo.conf) and how they work together to produce responses.Build and maintenance process updates:
- Added a recommended quick syntax check command for nginx after building the Docker image to catch configuration errors early.
- Clarified that updating the GeoLite2 databases requires rebuilding the Docker image, since the databases are fetched during the build stage.
PR Type
Documentation
Description
-
Clarify nginx-only architecture with no application code layer
-
Add dedicated architecture section describing config file roles
-
Include quick nginx syntax check command for post-build validation
-
Emphasize GeoLite2 database updates require image rebuild
Diagram Walkthrough
flowchart LR
A["Project Overview"] -->|"Add nginx-only note"| B["Enhanced clarity"]
C["Architecture Section"] -->|"New: geoip2, realip, ipinfo roles"| D["Config file documentation"]
E["Build Commands"] -->|"Add nginx -t check"| F["Post-build validation"]
G["Implementation Notes"] -->|"Emphasize rebuild requirement"| H["GeoLite2 update guidance"]
File Walkthrough
| Relevant files | |||
|---|---|---|---|
| Documentation |
|
Summary by CodeRabbit
- Documentation
- Expanded architecture overview to clarify configuration is handled via nginx directives (no app-layer config).
- Renamed and expanded the section describing key configuration files and their roles.
- Clarified that GeoLite2 databases are fetched at image build time and the image must be rebuilt to apply updates.
âī¸ Tip: You can customize this high-level summary in your review settings.