Skip to content

docs: improve README with real structure and troubleshooting tips#4837

Open
ochola-rich wants to merge 2 commits intosupabase:developfrom
ochola-rich:improve-readme
Open

docs: improve README with real structure and troubleshooting tips#4837
ochola-rich wants to merge 2 commits intosupabase:developfrom
ochola-rich:improve-readme

Conversation

@ochola-rich
Copy link

This PR updates the README to make it clearer and more helpful for contributors and users:

Fixed Project Structure to match the actual repo layout.

Added detailed Troubleshooting steps for common issues (local stack, migrations, CLI errors, type generation, function deployment).

Moved contribution instructions to CONTRIBUTING.md for clarity.

These changes make it easier to understand the project and solve problems while using or contributing to the CLI.

@ochola-rich ochola-rich requested a review from a team as a code owner February 10, 2026 13:14
@coveralls
Copy link

Pull Request Test Coverage Report for Build 21866367628

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • 5 unchanged lines in 1 file lost coverage.
  • Overall coverage decreased (-0.02%) to 60.55%

Files with Coverage Reduction New Missed Lines %
internal/gen/keys/keys.go 5 12.9%
Totals Coverage Status
Change from base Build 21859441939: -0.02%
Covered Lines: 7751
Relevant Lines: 12801

💛 - Coveralls

@ochola-rich
Copy link
Author

Thanks for the coverage report!
This PR only updates documentation, and no Go source files were added or modified.
The reported 0.02% coverage drop comes from unrelated lines being executed differently in CI, which is normal variance and not caused by this change. No additional tests are required.

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.

2 participants