Skip to content

Commit fcec6bf

Browse files
pryndorclaude
andcommitted
Organize development scripts into scripts/ directory
- Move deploy_docs.sh to scripts/ - Move quick_docs_setup.sh to scripts/ - Move test_docs.sh to scripts/ - Add scripts/README.md with usage documentation - Keep docs/install_man_page.sh (users need this) Cleaner root directory while keeping helper scripts available. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
1 parent 26c581d commit fcec6bf

4 files changed

Lines changed: 90 additions & 0 deletions

File tree

scripts/README.md

Lines changed: 90 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,90 @@
1+
# Development Scripts
2+
3+
Helper scripts for local documentation development and testing.
4+
5+
**Note:** These scripts are optional. GitHub Actions handles automatic deployment when you push to `main` branch.
6+
7+
## Scripts
8+
9+
### 📄 deploy_docs.sh
10+
Full-featured documentation deployment script.
11+
12+
**Usage:**
13+
```bash
14+
cd /path/to/Lixplore_cli
15+
./scripts/deploy_docs.sh # Preview locally
16+
./scripts/deploy_docs.sh --deploy # Deploy to GitHub Pages
17+
```
18+
19+
**Features:**
20+
- Validates documentation structure
21+
- Builds documentation site
22+
- Starts local preview server
23+
- Optionally deploys to GitHub Pages
24+
25+
---
26+
27+
### 📄 quick_docs_setup.sh
28+
Quick local documentation preview.
29+
30+
**Usage:**
31+
```bash
32+
cd /path/to/Lixplore_cli
33+
./scripts/quick_docs_setup.sh
34+
```
35+
36+
**What it does:**
37+
- Installs MkDocs if needed
38+
- Builds documentation
39+
- Starts server at http://127.0.0.1:8000
40+
41+
**Alternative:** Run `mkdocs serve` directly from project root.
42+
43+
---
44+
45+
### 📄 test_docs.sh
46+
Documentation verification and testing.
47+
48+
**Usage:**
49+
```bash
50+
cd /path/to/Lixplore_cli
51+
./scripts/test_docs.sh
52+
```
53+
54+
**What it does:**
55+
- Checks all 39 documentation files exist
56+
- Validates mkdocs.yml configuration
57+
- Tests documentation build
58+
- Reports pass/fail status
59+
60+
---
61+
62+
## Standard MkDocs Commands
63+
64+
You can also use standard MkDocs commands directly:
65+
66+
```bash
67+
# Install MkDocs
68+
pip install mkdocs mkdocs-material
69+
70+
# Preview locally
71+
mkdocs serve
72+
73+
# Build documentation
74+
mkdocs build
75+
76+
# Deploy to GitHub Pages
77+
mkdocs gh-deploy
78+
```
79+
80+
---
81+
82+
## Automatic Deployment
83+
84+
The repository uses GitHub Actions for automatic deployment:
85+
- Edit files in `docs/` directory
86+
- Commit and push to `main` branch
87+
- GitHub Actions automatically builds and deploys
88+
- Live at: https://pryndor.github.io/Lixplore_cli/
89+
90+
No manual deployment needed! 🚀
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)