Detailed Docs & Onboarding improvements

docs/api/ai_writers.rst

@@ -0,0 +1,127 @@
+AI Writers
+=========
+
+This section documents the AI writer modules that provide specialized content generation for different platforms.
+
+LinkedIn Writer
+-------------
+
+.. automodule:: lib.ai_writers.linkedin_writer
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+LinkedIn Post Generator
+~~~~~~~~~~~~~~~~~~~~~
+
+.. automodule:: lib.ai_writers.linkedin_writer.modules.post_generator
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+LinkedIn Article Generator
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. automodule:: lib.ai_writers.linkedin_writer.modules.article_generator
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+LinkedIn Profile Optimizer
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. automodule:: lib.ai_writers.linkedin_writer.modules.profile_optimizer
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Twitter Writer
+------------
+
+.. automodule:: lib.ai_writers.twitter_writers
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Tweet Generator
+~~~~~~~~~~~~~
+
+.. automodule:: lib.ai_writers.twitter_writers.tweet_generator
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Facebook Writer
+-------------
+
+.. automodule:: lib.ai_writers.ai_facebook_writer
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Facebook Ad Copy Generator
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. automodule:: lib.ai_writers.ai_facebook_writer.modules.ad_copy_generator
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Facebook Carousel Generator
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. automodule:: lib.ai_writers.ai_facebook_writer.modules.facebook_carousel
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+YouTube Writers
+-------------
+
+.. automodule:: lib.ai_writers.youtube_writers
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Story Writer
+----------
+
+.. automodule:: lib.ai_writers.ai_story_writer
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Copywriter
+---------
+
+.. automodule:: lib.ai_writers.ai_copywriter
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Blog Writers
+----------
+
+GitHub Blogs
+~~~~~~~~~~~
+
+.. automodule:: lib.ai_writers.github_blogs
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Scholar Blogs
+~~~~~~~~~~~
+
+.. automodule:: lib.ai_writers.scholar_blogs
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Speech to Blog
+~~~~~~~~~~~~
+
+.. automodule:: lib.ai_writers.speech_to_blog
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/api/analytics.rst

@@ -0,0 +1,12 @@
+Analytics
+=========
+
+This section documents the analytics modules that provide content performance tracking and visualization.
+
+Analytics Engine
+--------------
+
+.. automodule:: lib.analytics
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/api/core.rst

@@ -0,0 +1,51 @@
+Core API
+========
+
+This section documents the core modules of the AI-Writer platform.
+
+Main Application
+--------------
+
+.. automodule:: alwrity
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+GPT Providers
+-----------
+
+Text Generation
+~~~~~~~~~~~~~
+
+.. automodule:: lib.gpt_providers.text_generation.gemini_pro_text
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. automodule:: lib.gpt_providers.text_generation.mistral_chat_completion
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. automodule:: lib.gpt_providers.text_generation.deepseek_text_gen
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Image Generation
+~~~~~~~~~~~~~~
+
+.. automodule:: lib.gpt_providers.text_to_image_generation.main_generate_image_from_prompt
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. automodule:: lib.gpt_providers.text_to_image_generation.gen_gemini_images
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. automodule:: lib.gpt_providers.text_to_image_generation.gen_dali3_images
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/api/database.rst

@@ -0,0 +1,22 @@
+Database
+========
+
+This section documents the database modules that handle content storage, retrieval, and vector search capabilities.
+
+Database Models
+-------------
+
+.. automodule:: lib.database
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Vector Database
+-------------
+
+The vector database provides semantic search capabilities for content retrieval.
+
+.. automodule:: lib.workspace.alwrity_data.vectordb
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/api/index.rst

@@ -0,0 +1,83 @@
+.. _api-reference:
+
+API Reference
+============
+
+This section provides detailed documentation for the AI-Writer API, including module references, class hierarchies, and function specifications.
+
+.. toctree::
+   :maxdepth: 2
+   :caption: API Documentation:
+
+   core
+   ai_writers
+   database
+   utils
+   analytics
+   web_crawlers
+
+Core Modules
+-----------
+
+.. automodule:: alwrity
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+AI Writers
+---------
+
+The AI Writers modules provide specialized content generation for different platforms and content types.
+
+.. toctree::
+   :maxdepth: 1
+   
+   ai_writers/linkedin
+   ai_writers/twitter
+   ai_writers/blog
+   ai_writers/email
+
+Database
+-------
+
+The database modules handle content storage, retrieval, and vector search capabilities.
+
+.. toctree::
+   :maxdepth: 1
+   
+   database/models
+   database/vector_store
+   database/relational_store
+
+Utilities
+--------
+
+Utility modules provide supporting functionality across the application.
+
+.. toctree::
+   :maxdepth: 1
+   
+   utils/api_key_manager
+   utils/ui_setup
+   utils/seo_tools
+
+Analytics
+--------
+
+Analytics modules provide content performance tracking and visualization.
+
+.. toctree::
+   :maxdepth: 1
+   
+   analytics/content_analyzer
+   analytics/analytics_ui
+
+Web Crawlers
+-----------
+
+Web crawler modules provide research capabilities by extracting information from the web.
+
+.. toctree::
+   :maxdepth: 1
+   
+   web_crawlers/async_web_crawler

docs/api/utils.rst

@@ -0,0 +1,78 @@
+Utilities
+=========
+
+This section documents the utility modules that provide supporting functionality across the application.
+
+API Key Manager
+-------------
+
+.. automodule:: lib.utils.api_key_manager
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Website Analyzer
+--------------
+
+.. automodule:: lib.utils.website_analyzer
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+UI Components
+-----------
+
+.. automodule:: lib.alwrity_ui
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+SEO Tools
+--------
+
+.. automodule:: lib.ai_seo_tools
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Marketing Tools
+-------------
+
+.. automodule:: lib.ai_marketing_tools
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Blog Processing
+-------------
+
+.. automodule:: lib.blog_metadata
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. automodule:: lib.blog_postprocessing
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. automodule:: lib.blog_sections
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Content Planning
+--------------
+
+.. automodule:: lib.content_planning_calender
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Personalization
+-------------
+
+.. automodule:: lib.personalization
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/api/web_crawlers.rst

@@ -0,0 +1,28 @@
+Web Crawlers
+============
+
+This section documents the web crawler modules that provide research capabilities by extracting information from the web.
+
+Web Researcher
+------------
+
+.. automodule:: lib.ai_web_researcher
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Web Crawlers
+----------
+
+.. automodule:: lib.web_crawlers
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Research Storage
+--------------
+
+.. automodule:: lib.workspace.alwrity_web_research
+   :members:
+   :undoc-members:
+   :show-inheritance: