Skip to content

Commit 76172f8

Browse files
pem725claude
pem725
and
claude
committed
📚 Complete documentation website with mobile optimization
✅ COMPREHENSIVE DOCUMENTATION: • Configuration: Complete setup and customization guides • Usage: Daily operation, manual controls, and time rewind • Reference: CLI commands, file structure, and technical specs • Contributing: Development setup and contribution guidelines • Installation: Added troubleshooting section 🎨 MOBILE & TABLET OPTIMIZATION: • Enhanced responsive design for all screen sizes • Touch-friendly buttons and navigation (44px minimum targets) • Optimized typography and spacing for mobile reading • Tablet-specific grid layouts (2-column cards) • High-DPI display optimizations for crisp icons 🧹 SIMPLIFIED NAVIGATION: • Streamlined navigation to essential pages only • Removed placeholder/missing page references • Clean, focused structure for better UX • No more broken internal links 📱 CROSS-DEVICE COMPATIBILITY: • Mobile: Single column layout with larger touch targets • Tablet: Dual column layout with optimized spacing • Desktop: Full grid layout with hover effects • All devices: Consistent branding and functionality 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
1 parent e68ee5a commit 76172f8

8 files changed

Lines changed: 1957 additions & 16 deletions

File tree

‎docs/configuration/basic-config.md‎

Lines changed: 261 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,261 @@
1+
# Basic Configuration
2+
3+
Get your automation working exactly how you want with these simple configuration changes. Most users only need these essential settings.
4+
5+
## 🚀 Quick Setup
6+
7+
### 1. Find Your Configuration File
8+
9+
=== "Linux/macOS"
10+
11+
```bash
12+
# Open configuration file
13+
nano ~/.config/neuron-automation/config.py
14+
15+
# Or use your preferred editor
16+
code ~/.config/neuron-automation/config.py
17+
```
18+
19+
=== "Windows"
20+
21+
```powershell
22+
# Open configuration file
23+
notepad %USERPROFILE%\.config\neuron-automation\config.py
24+
25+
# Or use your preferred editor
26+
code %USERPROFILE%\.config\neuron-automation\config.py
27+
```
28+
29+
### 2. Essential Settings
30+
31+
Copy and paste these common configurations:
32+
33+
#### ⏰ **Morning Person Setup**
34+
```python
35+
# Runs early for early risers
36+
AUTOMATION_TIMES = ["05:00", "05:30", "06:00"]
37+
ENABLED_DAYS = [0, 1, 2, 3, 4] # Weekdays only
38+
```
39+
40+
#### 🌅 **Standard Setup** (Default)
41+
```python
42+
# Balanced timing for most users
43+
AUTOMATION_TIMES = ["05:30", "06:00", "06:30", "07:00"]
44+
ENABLED_DAYS = [0, 1, 2, 3, 4] # Weekdays only
45+
```
46+
47+
#### 🌤️ **Late Riser Setup**
48+
```python
49+
# Later start times
50+
AUTOMATION_TIMES = ["07:00", "07:30", "08:00"]
51+
ENABLED_DAYS = [0, 1, 2, 3, 4] # Weekdays only
52+
```
53+
54+
#### 📅 **Every Day Setup**
55+
```python
56+
# Runs 7 days a week
57+
AUTOMATION_TIMES = ["06:00", "06:30", "07:00"]
58+
ENABLED_DAYS = [0, 1, 2, 3, 4, 5, 6] # Every day
59+
```
60+
61+
#### 🎯 **Weekend Only Setup**
62+
```python
63+
# Only runs on weekends
64+
AUTOMATION_TIMES = ["08:00", "08:30"]
65+
ENABLED_DAYS = [5, 6] # Saturday & Sunday
66+
```
67+
68+
## 🔧 Common Customizations
69+
70+
### Link Management
71+
```python
72+
# How many days to wait before showing links again
73+
RECENT_LINK_DAYS = 1 # 1 day (recommended)
74+
# RECENT_LINK_DAYS = 3 # 3 days (less frequent)
75+
# RECENT_LINK_DAYS = 0 # No filtering (see everything)
76+
77+
# Automatically blacklist opened links
78+
AUTO_BLACKLIST_AFTER_OPENING = True # Recommended
79+
# AUTO_BLACKLIST_AFTER_OPENING = False # Keep showing same links
80+
```
81+
82+
### Browser Behavior
83+
```python
84+
# Keep browser tabs open after automation
85+
BROWSER_PERSISTENCE = True # Recommended for reading
86+
# BROWSER_PERSISTENCE = False # Close browser when done
87+
88+
# Run without showing browser window (background only)
89+
HEADLESS_MODE = False # Show browser (recommended)
90+
# HEADLESS_MODE = True # Run in background
91+
```
92+
93+
### Content Filtering
94+
```python
95+
# Skip links containing these words
96+
SKIP_LINK_PATTERNS = [
97+
"advertisement",
98+
"promo",
99+
"sponsor",
100+
"affiliate"
101+
]
102+
103+
# Maximum links to open per run (prevents overwhelming)
104+
MAX_LINKS_PER_RUN = 50 # Reasonable limit
105+
# MAX_LINKS_PER_RUN = 20 # Conservative limit
106+
# MAX_LINKS_PER_RUN = 100 # High limit
107+
```
108+
109+
## 🎛️ Settings Explained
110+
111+
### Days of Week
112+
```python
113+
# Day numbers:
114+
# 0 = Monday, 1 = Tuesday, 2 = Wednesday, 3 = Thursday
115+
# 4 = Friday, 5 = Saturday, 6 = Sunday
116+
117+
ENABLED_DAYS = [0, 1, 2, 3, 4] # Weekdays
118+
ENABLED_DAYS = [5, 6] # Weekends
119+
ENABLED_DAYS = [0, 2, 4] # Mon, Wed, Fri
120+
ENABLED_DAYS = [0, 1, 2, 3, 4, 5, 6] # Every day
121+
```
122+
123+
### Time Format
124+
```python
125+
# Use 24-hour format (HH:MM)
126+
AUTOMATION_TIMES = [
127+
"05:30", # 5:30 AM
128+
"06:00", # 6:00 AM
129+
"18:30", # 6:30 PM
130+
"23:00" # 11:00 PM
131+
]
132+
```
133+
134+
### Logging Levels
135+
```python
136+
LOG_LEVEL = "DEBUG" # Everything (for troubleshooting)
137+
LOG_LEVEL = "INFO" # Normal operations (recommended)
138+
LOG_LEVEL = "WARNING" # Only warnings and errors
139+
LOG_LEVEL = "ERROR" # Only errors
140+
```
141+
142+
## 💡 Configuration Tips
143+
144+
### For New Users
145+
```python
146+
# Start with these safe settings
147+
AUTOMATION_TIMES = ["06:30"] # Single time to test
148+
ENABLED_DAYS = [1] # Tuesday only
149+
RECENT_LINK_DAYS = 1 # Filter duplicates
150+
AUTO_BLACKLIST_AFTER_OPENING = True
151+
BROWSER_PERSISTENCE = True
152+
HEADLESS_MODE = False # See what's happening
153+
LOG_LEVEL = "INFO"
154+
```
155+
156+
### For Power Users
157+
```python
158+
# Advanced setup
159+
AUTOMATION_TIMES = ["05:30", "06:00", "06:30", "07:00", "08:00"]
160+
ENABLED_DAYS = [0, 1, 2, 3, 4]
161+
RECENT_LINK_DAYS = 0 # No filtering
162+
MAX_LINKS_PER_RUN = 100 # High limit
163+
LOG_LEVEL = "DEBUG" # Detailed logging
164+
```
165+
166+
### For Servers (Headless)
167+
```python
168+
# No GUI server setup
169+
HEADLESS_MODE = True
170+
BROWSER_PERSISTENCE = False # Don't keep browser open
171+
CHROME_OPTIONS = [
172+
"--no-sandbox",
173+
"--disable-dev-shm-usage",
174+
"--headless",
175+
"--disable-gpu"
176+
]
177+
LOG_LEVEL = "WARNING" # Minimal logging
178+
```
179+
180+
## ✅ Apply Configuration Changes
181+
182+
After making changes:
183+
184+
### 1. Save the File
185+
- **Linux/macOS**: `Ctrl + X` (nano), `Ctrl + S` (most editors)
186+
- **Windows**: `Ctrl + S`
187+
188+
### 2. Restart the Service
189+
=== "Linux"
190+
191+
```bash
192+
# Restart automation service
193+
systemctl --user restart neuron-automation.service
194+
195+
# Check status
196+
systemctl --user status neuron-automation.timer
197+
```
198+
199+
=== "macOS"
200+
201+
```bash
202+
# Restart launch agent
203+
launchctl unload ~/Library/LaunchAgents/com.neuron-automation.plist
204+
launchctl load ~/Library/LaunchAgents/com.neuron-automation.plist
205+
```
206+
207+
=== "Windows"
208+
209+
```powershell
210+
# Restart scheduled task
211+
Unregister-ScheduledTask -TaskName "NeuronAutomation" -Confirm:$false
212+
Register-ScheduledTask -Xml (Get-Content "task-definition.xml" | Out-String) -TaskName "NeuronAutomation"
213+
```
214+
215+
### 3. Test Your Changes
216+
```bash
217+
# Test with current configuration
218+
neuron-automation --dry-run
219+
220+
# Run once to test
221+
neuron-automation
222+
```
223+
224+
## 🛠️ Troubleshooting
225+
226+
### Configuration Not Working?
227+
228+
```bash
229+
# Check configuration syntax
230+
python -c "import sys; sys.path.append('~/.config/neuron-automation'); import config"
231+
232+
# View current configuration
233+
neuron-automation --show-config
234+
235+
# Reset to defaults
236+
neuron-automation --reset-config
237+
```
238+
239+
### Service Not Running?
240+
241+
```bash
242+
# Check if timer is active (Linux)
243+
systemctl --user is-active neuron-automation.timer
244+
245+
# View service logs
246+
journalctl --user -u neuron-automation.service -f
247+
```
248+
249+
### Browser Not Opening?
250+
251+
```bash
252+
# Test browser
253+
neuron-automation --test-browser
254+
255+
# Check Chrome installation
256+
google-chrome --version
257+
```
258+
259+
---
260+
261+
Ready for more advanced configuration? Check out [Advanced Settings](advanced-settings.md) or jump to [Usage](../usage/) to start using your configured system!

0 commit comments

Comments
 (0)