docs: update READMEs for context-aware architecture and local mode #8
Conversation
Refactor documentation to reflect v2.0 changes: - Introduce kubectl-style contexts for unified local/remote management - Integrate local Docker mode into core commands, deprecate separate `local` subcommands - Remove legacy `supascale.sh` guide and installation - Add badges, improve quick start examples, and expand troubleshooting - Update features, API endpoints, and project structure sections
Summary of ChangesHello @michaelruelas, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request significantly updates the documentation for the Highlights
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This is a great documentation overhaul that clearly explains the new context-aware architecture. The refactoring of both READMEs, the addition of badges, and the updated examples significantly improve the user experience and make the v2.0 changes easy to understand. The new structure is much more logical and user-friendly.
I've found a significant discrepancy between the documented behavior of supactl create for local contexts and its actual implementation. The documentation claims it's a unified command, but the code shows it's not supported for local mode, directing users to supactl local add instead. I've left several comments pointing out the specific places in the documentation that need to be corrected to align with the current implementation. I also found a minor duplication issue in the roadmap.
Overall, excellent work on the documentation. Addressing these inconsistencies will make it perfect.
README.md
Outdated
| # List all contexts | ||
| supactl config get-contexts | ||
|
|
||
| # Create and manage instances (works in both contexts) |
There was a problem hiding this comment.
The comment (works in both contexts) is misleading for the create command. The supactl create command is not implemented for the local context and will return an error. Please update the documentation to clarify that create is for remote contexts, while supactl local add should be used for local instance creation.
README.md
Outdated
| supactl local add my-project | ||
| supactl local list | ||
| supactl local start my-project | ||
| supactl create my-project |
There was a problem hiding this comment.
The documentation suggests using supactl create for local instances, but the implementation for the local provider doesn't support this and instead directs users to supactl local add. To align with the code, this should be supactl local add my-project.
| supactl create my-project | |
| supactl local add my-project |
SUPACTL_README.md
Outdated
| These work in local or remote contexts: | ||
|
|
||
| - `supactl create <name>`: Create new instance | ||
| - Local: Clones Supabase repo, generates secrets, configures Docker |
There was a problem hiding this comment.
This description is inconsistent with the implementation. The CreateInstance function for the local provider currently returns an error and directs the user to use supactl local add. Please either update the implementation to match this documented behavior or correct the documentation to state that supactl create is not supported for local mode.
SUPACTL_README.md
Outdated
| supactl delete my-awesome-app | ||
| # Confirm deletion | ||
| supactl config use-context local | ||
| supactl create dev-app # Or: local add dev-app |
There was a problem hiding this comment.
The example suggests supactl create dev-app is a valid command for the local workflow, but this is not supported by the current implementation. The primary command for creating a local instance is supactl local add dev-app.
| supactl create dev-app # Or: local add dev-app | |
| supactl local add dev-app |
README.md
Outdated
| - [ ] Web UI for instance management | ||
| - [ ] Instance templates and presets | ||
| - [ ] Automated backups and restoration |
There was a problem hiding this comment.
These roadmap items appear to be duplicates of the ones listed on lines 450-452. You can remove these lines to avoid redundancy.
Update READMEs to reflect that `supactl create` is remote-only and introduce `local add` for local instances. Remove outdated roadmap items.
Refactor documentation to reflect v2.0 changes:
localsubcommandssupascale.shguide and installation