Skip to content

chore: remove redundant init_db.sh script and documentation references#64

Open
Farhan-Abbas wants to merge 2 commits into
denoslab:mainfrom
Farhan-Abbas:readme_fix
Open

chore: remove redundant init_db.sh script and documentation references#64
Farhan-Abbas wants to merge 2 commits into
denoslab:mainfrom
Farhan-Abbas:readme_fix

Conversation

@Farhan-Abbas
Copy link
Copy Markdown
Collaborator

Fixes Issue #60

Copilot AI review requested due to automatic review settings May 11, 2026 07:26
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Removes the unused init_db.sh database initialization script and updates quick-start documentation to avoid instructing users to manually create a database that Docker/Postgres already provisions on first initialization (Fixes Issue #60).

Changes:

  • Removed workbench/init_db.sh.
  • Updated setup instructions in workbench/README.md, root README.md, and docs/getting-started.md to drop the redundant DB init step and renumber steps accordingly.
  • Removed the obsolete initialization reference from CLAUDE.md.

Reviewed changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
workbench/README.md Updates “First Time Setup” to remove init_db.sh and focus on migrations/superuser creation.
workbench/init_db.sh Deletes the redundant DB creation script.
README.md Removes the DB init step from the top-level quick start and renumbers remaining steps.
docs/getting-started.md Mirrors the quick-start update by removing the DB init step and renumbering.
CLAUDE.md Removes the first-time init_db.sh instruction.
Comments suppressed due to low confidence (1)

README.md:90

  • Since init_db.sh was removed, the docs no longer mention what to do if the PostgreSQL volume already exists but the starfish-router DB is missing (common after manual DB cleanup or reusing old volumes). Consider adding a brief troubleshooting note near this step explaining that DB creation only happens on first init, and users can either recreate the DB inside Postgres or remove the postgres_data volume and rerun make up.
3. **Run migrations and create superuser** (first time only)
   ```bash
   docker exec -it starfish-router poetry run python3 manage.py makemigrations
   docker exec -it starfish-router poetry run python3 manage.py migrate
   docker exec -it starfish-router poetry run python3 manage.py createsuperuser
</details>



---

💡 <a href="/denoslab/starfish-fl/new/main?filename=.github/instructions/*.instructions.md" class="Link--inTextBlock" target="_blank" rel="noopener noreferrer">Add Copilot custom instructions</a> for smarter, more guided reviews. <a href="https://docs.github.com/en/copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot" class="Link--inTextBlock" target="_blank" rel="noopener noreferrer">Learn how to get started</a>.

Comment thread workbench/README.md Outdated
Comment thread docs/getting-started.md
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