starred/ALwrity
1
0
Fork 0
mirror of https://github.com/AJaySi/ALwrity.git synced 2026-04-25 08:55:58 +03:00
Code Issues 82 Projects Releases 4 Packages Wiki Activity

[PR #311] [CLOSED] docs: Fix incorrect database initialization command #281

New issue
Closed
opened 2026-03-02 23:34:57 +03:00 by kerem · 0 comments
kerem commented 2026-03-02 23:34:57 +03:00
Owner
Copy link

📋 Pull Request Information

Original PR: https://github.com/AJaySi/ALwrity/pull/311
Author: @oxcodexo
Created: 11/22/2025
Status: ❌ Closed

Base: main ← Head: docs/fix-db-init-command

📝 Commits (1)

  • f0d0920 docs: fix incorrect database initialization command" -m "Update installation, configuration, and troubleshooting guides to reference the correct function name 'init_database' instead of 'initialize_database'. This fixes an ImportError that occurred when following the installation instructions.

📊 Changes

3 files changed (+4 additions, -4 deletions)

View changed files

📝 docs-site/docs/getting-started/configuration.md (+1 -1)
📝 docs-site/docs/getting-started/installation.md (+2 -2)
📝 docs-site/docs/guides/troubleshooting.md (+1 -1)

📄 Description

Pull Request

📝 Description

This PR corrects the database initialization command in the installation and configuration guides. The documentation previously referenced initialize_database, which caused an ImportError because the actual function in services/database.py is named init_database.

Changes:

🔄 Type of Change

  • 🐛 Bug fix (non-breaking change which fixes an issue)
  • ✨ New feature (non-breaking change which adds functionality)
  • 💥 Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • 📚 Documentation update
  • 🎨 Style/UI changes
  • ♻️ Code refactoring
  • ⚡ Performance improvements
  • 🧪 Test additions/updates

🎯 Related Issues

Fixes ImportError: cannot import name 'initialize_database' from 'services.database' during setup.

🧪 Testing

  • Backend tests pass
  • Frontend tests pass
  • Manual testing completed
  • Cross-browser testing (if applicable)
  • Mobile testing (if applicable)

Verification:
Ran the corrected command python -c "from services.database import init_database; init_database()" and confirmed it successfully initializes the database without errors.

📸 Screenshots (if applicable)

N/A

🏷️ Component/Feature

Which component or feature is affected?

  • Blog Writer
  • SEO Dashboard
  • Content Planning
  • Facebook Writer
  • LinkedIn Writer
  • Onboarding
  • Authentication
  • API
  • Database
  • GSC Integration
  • Subscription System
  • Monitoring/Billing
  • Documentation
  • Other: _______________

📋 Checklist

  • My code follows the project's style guidelines
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published

ALwrity-Specific Checklist

  • API endpoints follow RESTful conventions
  • AI service integrations handle rate limits and errors gracefully
  • Content generation includes proper validation and sanitization
  • Database migrations are included if schema changes are made
  • Environment variables are documented in env_template.txt
  • Security considerations have been addressed
  • Performance impact has been considered
  • User experience is consistent with existing features

🔍 Code Quality

  • Code is properly formatted
  • No console.log statements left in production code
  • Error handling is implemented where needed
  • Performance considerations have been addressed
  • Security considerations have been addressed

📚 Documentation

  • README updated (if needed)
  • API documentation updated (if needed)
  • Code comments added for complex logic
  • Changelog updated (if applicable)

🚀 Deployment Notes

None.

🔗 Additional Context

This was a blocking issue for new installations.

👥 Reviewers

Tag specific reviewers if needed:
@AJaySi @uniqueumesh @DikshaDisciplines

🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/AJaySi/ALwrity/pull/311 **Author:** [@oxcodexo](https://github.com/oxcodexo) **Created:** 11/22/2025 **Status:** ❌ Closed **Base:** `main` ← **Head:** `docs/fix-db-init-command` --- ### 📝 Commits (1) - [`f0d0920`](https://github.com/AJaySi/ALwrity/commit/f0d092014402b80ae7e9c4c8d2b273c03b61f66b) docs: fix incorrect database initialization command" -m "Update installation, configuration, and troubleshooting guides to reference the correct function name 'init_database' instead of 'initialize_database'. This fixes an ImportError that occurred when following the installation instructions. ### 📊 Changes **3 files changed** (+4 additions, -4 deletions) <details> <summary>View changed files</summary> 📝 `docs-site/docs/getting-started/configuration.md` (+1 -1) 📝 `docs-site/docs/getting-started/installation.md` (+2 -2) 📝 `docs-site/docs/guides/troubleshooting.md` (+1 -1) </details> ### 📄 Description # Pull Request ## 📝 Description This PR corrects the database initialization command in the installation and configuration guides. The documentation previously referenced `initialize_database`, which caused an `ImportError` because the actual function in [services/database.py](cci:7://file:///home/oxcodexo/Desktop/projects/ai-blogger/ai-writy/backend/services/database.py:0:0-0:0) is named [init_database](cci:1://file:///home/oxcodexo/Desktop/projects/ai-blogger/ai-writy/backend/services/database.py:62:0-79:13). **Changes:** * Updated [docs/getting-started/installation.md](cci:7://file:///home/oxcodexo/Desktop/projects/ai-blogger/ai-writy/docs-site/docs/getting-started/installation.md:0:0-0:0) * Updated [docs/getting-started/configuration.md](cci:7://file:///home/oxcodexo/Desktop/projects/ai-blogger/ai-writy/docs-site/docs/getting-started/configuration.md:0:0-0:0) * Updated [docs/guides/troubleshooting.md](cci:7://file:///home/oxcodexo/Desktop/projects/ai-blogger/ai-writy/docs-site/docs/guides/troubleshooting.md:0:0-0:0) ## 🔄 Type of Change - [x] 🐛 Bug fix (non-breaking change which fixes an issue) - [ ] ✨ New feature (non-breaking change which adds functionality) - [ ] 💥 Breaking change (fix or feature that would cause existing functionality to not work as expected) - [x] 📚 Documentation update - [ ] 🎨 Style/UI changes - [ ] ♻️ Code refactoring - [ ] ⚡ Performance improvements - [ ] 🧪 Test additions/updates ## 🎯 Related Issues Fixes `ImportError: cannot import name 'initialize_database' from 'services.database'` during setup. ## 🧪 Testing - [ ] Backend tests pass - [ ] Frontend tests pass - [x] Manual testing completed - [ ] Cross-browser testing (if applicable) - [ ] Mobile testing (if applicable) **Verification:** Ran the corrected command `python -c "from services.database import init_database; init_database()"` and confirmed it successfully initializes the database without errors. ## 📸 Screenshots (if applicable) N/A ## 🏷️ Component/Feature Which component or feature is affected? - [ ] Blog Writer - [ ] SEO Dashboard - [ ] Content Planning - [ ] Facebook Writer - [ ] LinkedIn Writer - [ ] Onboarding - [ ] Authentication - [ ] API - [x] Database - [ ] GSC Integration - [ ] Subscription System - [ ] Monitoring/Billing - [x] Documentation - [ ] Other: _______________ ## 📋 Checklist - [x] My code follows the project's style guidelines - [x] I have performed a self-review of my own code - [x] I have commented my code, particularly in hard-to-understand areas - [x] I have made corresponding changes to the documentation - [x] My changes generate no new warnings - [x] I have added tests that prove my fix is effective or that my feature works - [ ] New and existing unit tests pass locally with my changes - [ ] Any dependent changes have been merged and published ### ALwrity-Specific Checklist - [ ] API endpoints follow RESTful conventions - [ ] AI service integrations handle rate limits and errors gracefully - [ ] Content generation includes proper validation and sanitization - [ ] Database migrations are included if schema changes are made - [ ] Environment variables are documented in env_template.txt - [ ] Security considerations have been addressed - [ ] Performance impact has been considered - [x] User experience is consistent with existing features ## 🔍 Code Quality - [x] Code is properly formatted - [x] No console.log statements left in production code - [ ] Error handling is implemented where needed - [ ] Performance considerations have been addressed - [ ] Security considerations have been addressed ## 📚 Documentation - [ ] README updated (if needed) - [ ] API documentation updated (if needed) - [ ] Code comments added for complex logic - [ ] Changelog updated (if applicable) ## 🚀 Deployment Notes None. ## 🔗 Additional Context This was a blocking issue for new installations. ## 👥 Reviewers Tag specific reviewers if needed: @AJaySi @uniqueumesh @DikshaDisciplines --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
kerem 2026-03-02 23:34:57 +03:00
Sign in to join this conversation.
No Branch/Tag specified
Branches Tags
main
codex/task-title-3y5pbt
codex/task-title-lsrpho
codex/task-title
codex/locate-and-render-brollinfopanel-component
codex/import-scene-composition-symbols-in-broll_service
codex/refactor-preview-generation-flow
codex/standardize-chart-preview-route-usage
codex/import-b-roll-handler-and-update-router
codex/implement-podcast-research-response-updates
codex/add-cost-estimation-feature-to-podcastdashboard
codex/remove-heuristic-calculators-and-update-estimates-bhvhnh
codex/remove-heuristic-calculators-and-update-estimates
codex/implement-dedicated-podcastcostest-model
codex/add-podcast-maker-feature-documentation
codex/review-flat-file-context-system-implementation
codex/create-podcast-maker-best-practices-documentation
codex/add-podcast-maker-journey-pages-for-personas
codex/refactor-podcast-maker-documentation-structure
dependabot/npm_and_yarn/frontend/npm_and_yarn-7d3393088f
codex/log-skipped-and-loaded-items
codex/create-startup-phases-for-podcast-demo-tugrzv
codex/create-startup-phases-for-podcast-demo
codex/add-api-feature-profile-status-endpoint
codex/refactor-routermanager-to-use-registry
codex/add-new-modules-for-feature-management
codex/downgrade-api-key-warning-logging
codex/refactor-onboarding-loading-logic
codex/add-ci-lint-check-for-user_id-patterns
codex/remove-sessionlocal-import-and-add-health-check
codex/refactor-dubbed_audio_dir-to-tenant-path-resolver
codex/update-task-metadata-and-api-responses
codex/verify-podcast-analysis-and-cost-tracking
codex/assert-api-endpoints-on-startup
codex/add-env-controlled-guard-for-stripe-key
codex/remove-feature-flag-for-production-demo
codex/add-mode-aware-redirect-logic-in-pricingpage
codex/document-deployment-configuration-for-demo-mode
codex/ensure-api.subscription.router-always-included
codex/guard-onboarding-manager-and-endpoints
codex/wrap-router-inclusion-in-demo-mode-check
codex/add-podcast-only-demo-mode-toggle
dependabot/npm_and_yarn/frontend/npm_and_yarn-f5ea90b336
codex/update-reset_current_billing_period-logic
codex/update-error-handling-in-monitoring-middleware
codex/move-stripe_plan_price_mapping-to-env-driven-config
codex/refactor-billingservice-to-use-authenticated-user
codex/update-user-access-verification-for-routes
session/agent_eae6711f-e04b-4d48-8d66-43ee051feb7b
v0.5.0
v0.3
v0.2
v0.1
Labels
Clear labels   
AI Content Agents

   
AI Content Strategy

   
AI Content planning

   
AI Marketing Tools

   
AI SEO

   
AI personalization

   
AI writer

   
ALwrity Copi-lot

   
Alwrity web search

   
Anthropic

   
DeepSeek

   
Gemini AI

   
Integration

   
LLM

   
OnBoarding

   
OnBoarding

   
RAG knowledgebase Memory

   
bug

   
documentation

   
enhancement

   
good first issue

   
help wanted

   
invalid

   
openai

   
pull-request

Mirrored from GitHub Pull Request

No labels
AI Content Agents
AI Content Strategy
AI Content planning
AI Marketing Tools
AI SEO
AI personalization
AI writer
ALwrity Copi-lot
Alwrity web search
Anthropic
DeepSeek
Gemini AI
Integration
LLM
OnBoarding
OnBoarding
RAG knowledgebase Memory
bug
documentation
enhancement
good first issue
help wanted
invalid
openai
pull-request
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
starred/ALwrity#281
No description provided.