Update to docs (#246)

* update installation instruction

* reneame configuration guide to configuration reference

* update docs

.gitignore

@@ -2,7 +2,9 @@
 __pycache__/
 *.py[cod]
 *$py.class
-
+CLAUDE.md
+.ruff*
+.claude
 # C extensions
 *.so
 

README.md

@@ -111,6 +111,7 @@ The program will open a browser, search Facebook Marketplace, and notify you of
 ## 💡 Example Usage
 
 **Find GoPro cameras under $300:**
+
 ```toml
 [item.gopro]
 search_phrases = 'Go Pro Hero'
@@ -120,6 +121,7 @@ max_price = 300
 ```
 
 **Search nationwide with shipping:**
+
 ```toml
 [item.rare_item]
 search_phrases = 'vintage collectible'
@@ -129,6 +131,7 @@ seller_locations = []
 ```
 
 **AI-powered filtering:**
+
 ```toml
 [ai.openai]
 api_key = 'your_openai_key'
@@ -145,30 +148,34 @@ For detailed information on setup and advanced features, see the comprehensive d
 
 - **[📖 Full Documentation](https://ai-marketplace-monitor.readthedocs.io/)** - Complete guide and reference
 - **[🚀 Quick Start Guide](https://ai-marketplace-monitor.readthedocs.io/en/latest/quickstart.html)** - Get up and running in 10 minutes
-- **[⚙️ Configuration](https://ai-marketplace-monitor.readthedocs.io/en/latest/configuration.html)** - Complete configuration reference
-- **[🔧 Advanced Features](https://ai-marketplace-monitor.readthedocs.io/en/latest/advanced-features.html)** - Notifications, AI prompts, multi-location search
-- **[📱 Usage Guide](https://ai-marketplace-monitor.readthedocs.io/en/latest/usage.html)** - Command-line options and tips
 - **[🔍 Features Overview](https://ai-marketplace-monitor.readthedocs.io/en/latest/features.html)** - Complete feature list
+- **[📱 Usage Guide](https://ai-marketplace-monitor.readthedocs.io/en/latest/usage.html)** - Command-line options and tips
+- **[🔧 Configuration Guide](https://ai-marketplace-monitor.readthedocs.io/en/latest/configurateion-guide.html)** - Notifications, AI prompts, multi-location search
+- **[⚙️ Configuration Reference](https://ai-marketplace-monitor.readthedocs.io/en/latest/configuration.html)** - Complete configuration reference
 
 ### Key Topics Covered in Documentation
 
 **Notification Setup:**
+
 - Email (SMTP), PushBullet, PushOver, Telegram, Ntfy
 - Multi-user configurations
 - HTML email templates
 
 **AI Integration:**
+
 - OpenAI, DeepSeek, Ollama setup
 - Custom prompt configuration
 - Rating thresholds and filtering
 
 **Advanced Search:**
+
 - Multi-city and region search
 - Currency conversion
 - Keyword filtering with Boolean logic
 - Proxy/anonymous searching
 
 **Configuration:**
+
 - TOML file structure
 - Environment variables
 - Multiple marketplace support

docs/README.md

@@ -1,4 +1,4 @@
-# Configuration Guide
+# Configuration Reference
 
 **Table of content:**
 

docs/configuration-guide.rst

@@ -1,6 +1,6 @@
-================
-Advanced Features
-================
+===================
+Configuration Guide
+===================
 
 This section covers advanced configuration options and setup procedures for AI Marketplace Monitor.
 

docs/contributing.rst

@@ -279,7 +279,7 @@ Simple Contributions
 -------------------
 
 1. **Fix typos** in documentation
-2. **Add examples** to configuration guide
+2. **Add examples** to configuration reference
 3. **Improve error messages** for better user experience
 4. **Add tests** for existing functionality
 5. **Translate** interface messages

docs/index.rst

@@ -18,14 +18,14 @@ Getting Started
    usage
    features
 
-Configuration & Setup
-====================
+Reference & Setup
+=================
 
 .. toctree::
    :maxdepth: 2
 
-   configuration
-   advanced-features
+   configuration-guide
+   Configuration Reference <configuration>
    troubleshooting
 
 Development & Reference
@@ -34,7 +34,6 @@ Development & Reference
 .. toctree::
    :maxdepth: 2
 
-   modules
    changelog
    contributing
 

docs/installation.rst

@@ -25,11 +25,16 @@ Install a browser for Playwright:
 
     $ playwright install
 
-For more detailed instructions, please refer to:
+For community-contributed instructions, see:
 
-- `Linux (pipx) installation guide <https://github.com/BoPeng/ai-marketplace-monitor/blob/main/INSTALL.linux.md>`_
 - `Community installation instructions #234 <https://github.com/BoPeng/ai-marketplace-monitor/issues/234>`_
 
+Linux Installation (using pipx)
+--------------------------------
+
+.. include:: linux-installation.md
+   :parser: myst_parser.sphinx_
+
 Development Installation
 ------------------------
 

docs/linux-installation.md

@@ -1,8 +1,6 @@
-## Linux Ubuntu Installation (using pipx)
-
 If you're using Ubuntu Linux and prefer not to use package managers like conda/mamba or virtual environments, you can install `ai-marketplace-monitor` as a system-wide command using `pipx`.
 
-### Prerequisites
+## Prerequisites
 
 If you haven't used `pipx` before or don't have `$HOME/.local/bin` in your `$PATH`:
 
@@ -15,7 +13,7 @@ source ~/.bashrc
 
 **Note:** You may need to restart your terminal or run `exec bash` instead of `source ~/.bashrc` for the PATH changes to take effect.
 
-### Installation
+## Installation
 
 ```bash
 # Install the main package
@@ -34,7 +32,7 @@ If prompted to install playwright system dependencies, run:
 sudo /home/YOURUSER/.local/bin/playwright install-deps
 ```
 
-### Configuration
+## Configuration
 
 Edit your configuration file using your preferred text editor:
 
@@ -49,7 +47,7 @@ vim ~/.ai-marketplace-monitor/config.toml
 sudo snap install code --classic
 ```
 
-### Verification
+## Verification
 
 To verify the installation was successful:
 
@@ -57,7 +55,7 @@ To verify the installation was successful:
 ai-marketplace-monitor --version
 ```
 
-### Troubleshooting
+## Troubleshooting
 
 - If you encounter permission issues, ensure `$HOME/.local/bin` is in your PATH
 - If playwright browsers fail to install, you may need to install additional system dependencies with `sudo apt install libnss3-dev libatk-bridge2.0-dev libdrm2-dev`

docs/quickstart.rst

@@ -120,7 +120,7 @@ And receive a notification on your phone via PushBullet.
 Next Steps
 ----------
 
-- :doc:`configuration` - Learn about advanced configuration options
+- :doc:`configuration` - Complete TOML configuration reference
 - :doc:`features` - Explore all available features
 - :doc:`usage` - Master command-line options and interactive mode
 - `GitHub Issues <https://github.com/BoPeng/ai-marketplace-monitor/issues>`_ - Get help or report problems