Skip to content

Fix readme #1679

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
VirajSalaka wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Fix readme #1679

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion gateway/gateway-controller/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ server:

# Storage configuration
storage:
type: sqlite # "sqlite", "postgres", or "memory"
type: sqlite # "sqlite", "postgres"
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot Apr 9, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟠 Major

Remove remaining memory references to keep storage docs consistent.

Line 100 is correct, but the README still documents memory as supported (Line 146, Lines 205-211, Line 258). That conflicts with actual validation/factory behavior (sqlite/postgres only) and will mislead users into invalid configs.

Suggested README cleanup 
-# Set storage type to memory
-export APIP_GW_GATEWAY__CONTROLLER_STORAGE_TYPE=memory
-
-#### Memory-Only Mode
-No persistent storage (useful for testing):
-
-```yaml
-storage:
-  type: memory
-```
-
-See `config/` directory for examples:
-- `config.yaml` - Default production configuration
-- `config-memory-only.yaml` - Testing/development configuration
+See `config/` directory for examples:
+- `config.yaml` - Default production configuration
🤖 Prompt for AI Agents 
Verify each finding against the current code and only fix it if needed.

In `@gateway/gateway-controller/README.md` at line 100, README still lists
"memory" as a supported storage type which conflicts with the code
(factory/validation only accept "sqlite" and "postgres"); remove all remaining
`memory` references and example blocks that show `type: memory` (update the
examples under storage, the config examples list that mentions
`config-memory-only.yaml`, and any code sample lines at the noted locations) and
replace with the correct supported types or a note that only `sqlite` and
`postgres` are supported so the docs match the behavior of the storage
factory/validation.

sqlite:
path: ./data/gateway.db # SQLite database file path
postgres: # Used when type=postgres
Expand Down
Loading