Skip to content

Commit a717e64

Browse files
TimeLoverccTimeLovercc
committed
update docs
1 parent 5dfe20a commit a717e64

File tree

11 files changed

+2683
-0
lines changed

11 files changed

+2683
-0
lines changed

‎.github/workflows/deploy-docs.yml‎

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
name: Deploy Documentation
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
paths:
8+
- 'docs/**'
9+
- 'mkdocs.yml'
10+
- '.github/workflows/deploy-docs.yml'
11+
workflow_dispatch: # Allow manual trigger
12+
13+
permissions:
14+
contents: read
15+
pages: write
16+
id-token: write
17+
18+
# Allow one concurrent deployment
19+
concurrency:
20+
group: "pages"
21+
cancel-in-progress: true
22+
23+
jobs:
24+
build:
25+
runs-on: ubuntu-latest
26+
steps:
27+
- name: Checkout
28+
uses: actions/checkout@v4
29+
with:
30+
fetch-depth: 0 # Fetch all history for git-revision-date-localized-plugin
31+
32+
- name: Setup Python
33+
uses: actions/setup-python@v5
34+
with:
35+
python-version: '3.11'
36+
cache: 'pip'
37+
38+
- name: Install dependencies
39+
run: |
40+
pip install mkdocs mkdocs-material pymdown-extensions
41+
pip install mkdocs-git-revision-date-localized-plugin
42+
pip install mkdocs-minify-plugin
43+
44+
- name: Build documentation
45+
run: mkdocs build
46+
47+
- name: Upload artifact
48+
uses: actions/upload-pages-artifact@v3
49+
with:
50+
path: ./site
51+
52+
deploy:
53+
if: github.event_name == 'push' || github.event_name == 'workflow_dispatch'
54+
needs: build
55+
runs-on: ubuntu-latest
56+
environment:
57+
name: github-pages
58+
url: ${{ steps.deployment.outputs.page_url }}
59+
steps:
60+
- name: Deploy to GitHub Pages
61+
id: deployment
62+
uses: actions/deploy-pages@v4

‎docs/README.md‎

Lines changed: 231 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,231 @@
1+
# Sleepless Agent Documentation
2+
3+
This documentation provides comprehensive guides, references, and tutorials for the Sleepless Agent - a 24/7 AI automation system powered by Claude Code.
4+
5+
## Documentation Structure
6+
7+
```
8+
docs/
9+
├── index.md # Main landing page
10+
├── quickstart.md # 5-minute getting started
11+
├── installation.md # Detailed installation guide
12+
├── faq.md # Frequently asked questions
13+
├── troubleshooting.md # Common issues and solutions
14+
├── changelog.md # Version history
15+
├── mkdocs.yml # MkDocs configuration
16+
│
17+
├── concepts/ # Core concepts and architecture
18+
│ ├── index.md # Concepts overview
19+
│ ├── architecture.md # System architecture
20+
│ ├── task-lifecycle.md # How tasks flow through system
21+
│ ├── workspace-isolation.md # Isolation and security model
22+
│ ├── scheduling.md # Task scheduling algorithms
23+
│ └── pro-plan-management.md # Claude Pro usage optimization
24+
│
25+
├── guides/ # Step-by-step guides
26+
│ ├── index.md # Guides overview
27+
│ ├── slack-setup.md # Complete Slack configuration
28+
│ ├── environment-setup.md # Environment variables and config
29+
│ └── git-integration.md # Git automation setup
30+
│
31+
├── reference/ # Technical reference
32+
│ └── api/
33+
│ └── cli-commands.md # CLI command reference
34+
│
35+
└── assets/ # Images and diagrams
36+
```
37+
38+
## Documentation Highlights
39+
40+
### 🚀 Quick Start
41+
- **[Quickstart Guide](quickstart.md)** - Get running in 5 minutes
42+
- **[Installation](installation.md)** - Platform-specific setup instructions
43+
- **[FAQ](faq.md)** - Answers to common questions
44+
45+
### 🧠 Core Concepts
46+
- **[Architecture](concepts/architecture.md)** - Understand system design
47+
- **[Task Lifecycle](concepts/task-lifecycle.md)** - Task execution flow
48+
- **[Workspace Isolation](concepts/workspace-isolation.md)** - Security model
49+
- **[Pro Plan Management](concepts/pro-plan-management.md)** - Usage optimization
50+
51+
### 📖 Configuration Guides
52+
- **[Slack Setup](guides/slack-setup.md)** - Complete Slack integration
53+
- **[Environment Setup](guides/environment-setup.md)** - Configuration management
54+
- **[Git Integration](guides/git-integration.md)** - Automated version control
55+
56+
### 📋 Reference
57+
- **[CLI Commands](reference/api/cli-commands.md)** - Complete command reference
58+
- **[Troubleshooting](troubleshooting.md)** - Solve common problems
59+
60+
## Key Features Documented
61+
62+
### System Architecture
63+
- Modular, event-driven design
64+
- Parallel task execution
65+
- Isolated workspace management
66+
- Resource optimization
67+
68+
### Slack Integration
69+
- Step-by-step app creation
70+
- Socket Mode configuration
71+
- Slash command setup
72+
- Permission management
73+
74+
### Git Automation
75+
- Automatic commits for tasks
76+
- Pull request creation
77+
- Multi-repository support
78+
- Security best practices
79+
80+
### Pro Plan Management
81+
- Intelligent usage tracking
82+
- Time-based thresholds (day/night)
83+
- Automatic pausing at limits
84+
- Usage optimization strategies
85+
86+
### Task Management
87+
- Priority-based scheduling
88+
- Project organization
89+
- Dependency handling
90+
- Result storage
91+
92+
## Building the Documentation
93+
94+
### Prerequisites
95+
96+
```bash
97+
pip install mkdocs mkdocs-material
98+
```
99+
100+
### Local Development
101+
102+
```bash
103+
# Serve documentation locally
104+
cd docs
105+
mkdocs serve
106+
107+
# View at http://localhost:8000
108+
```
109+
110+
### Build Static Site
111+
112+
```bash
113+
# Build documentation
114+
mkdocs build
115+
116+
# Output in site/ directory
117+
```
118+
119+
### Deploy to GitHub Pages
120+
121+
```bash
122+
# Deploy to gh-pages branch
123+
mkdocs gh-deploy
124+
```
125+
126+
## Documentation Standards
127+
128+
### Writing Style
129+
- Clear, concise language
130+
- Step-by-step instructions
131+
- Code examples for every concept
132+
- Visual diagrams where helpful
133+
134+
### Structure
135+
- Progressive disclosure (simple → complex)
136+
- Consistent formatting
137+
- Cross-references between related topics
138+
- Complete examples
139+
140+
### Content Types
141+
- **Concepts** - Explain how things work
142+
- **Guides** - Show how to do things
143+
- **Tutorials** - Learn by doing
144+
- **Reference** - Complete specifications
145+
146+
## Contributing to Documentation
147+
148+
### Adding New Content
149+
150+
1. Choose appropriate section (concepts/guides/tutorials/reference)
151+
2. Follow existing naming conventions
152+
3. Update navigation in mkdocs.yml
153+
4. Include code examples
154+
5. Add cross-references
155+
156+
### Style Guide
157+
158+
- Use ATX-style headers (`#`, not underlines)
159+
- Include code language in fenced blocks
160+
- Use tables for structured data
161+
- Add admonitions for important notes
162+
163+
### Example Structure
164+
165+
```markdown
166+
# Page Title
167+
168+
Brief introduction paragraph.
169+
170+
## Overview
171+
172+
High-level explanation.
173+
174+
## Details
175+
176+
### Subsection
177+
178+
Detailed content with examples:
179+
180+
\`\`\`python
181+
# Code example
182+
def example():
183+
return "example"
184+
\`\`\`
185+
186+
## Best Practices
187+
188+
- Bullet points for lists
189+
- **Bold** for emphasis
190+
- `code` for inline code
191+
192+
## See Also
193+
194+
- [Related Topic](link.md)
195+
```
196+
197+
## Documentation Coverage
198+
199+
### ✅ Completed
200+
- Core documentation structure
201+
- All concept documents (5/5)
202+
- Essential guides (3/5+)
203+
- Root documentation files
204+
- MkDocs configuration
205+
- CLI commands reference
206+
207+
### 🚧 Planned Additions
208+
- Remaining guides (project management, custom prompts, deployment)
209+
- Tutorial documents (first task, workflows, monitoring, reports)
210+
- API reference (Slack commands, Python API)
211+
- Configuration reference
212+
- Database schema reference
213+
- Example code and workflows
214+
215+
## Quick Links
216+
217+
- [Main Documentation](index.md)
218+
- [Quickstart](quickstart.md)
219+
- [Slack Setup](guides/slack-setup.md)
220+
- [Architecture](concepts/architecture.md)
221+
- [CLI Reference](reference/api/cli-commands.md)
222+
223+
## Support
224+
225+
- **Documentation Issues**: Open an issue with the `documentation` label
226+
- **Discord**: Join our community for help
227+
- **Contributing**: See CONTRIBUTING.md for guidelines
228+
229+
---
230+
231+
*This documentation follows the style and structure of professional open-source projects like ContextAgent, providing comprehensive coverage of all aspects of the Sleepless Agent system.*

0 commit comments

Comments
 (0)