Skip to content

Commit c0d654a

Browse files
foharaclaude
andcommitted
docs: Add comprehensive documentation suite
Add complete documentation including: - User guide with all CLI commands and features - Developer guide with architecture and contribution info - Agent integration guide for AI agents using Lash - CONTRIBUTING.md with code of conduct and guidelines - Documentation style guide - Examples directory with 5 tutorials: - Simple TODO list - Multi-file project - Software project (e-commerce) - Agent workflow - Complex dependencies Also includes: - CI workflow with markdown link checking - Updated error-codes.md with new error categories - Updated README with documentation links - Updated tasks.documentation.md tracking 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
1 parent 657fe3e commit c0d654a

31 files changed

Lines changed: 8609 additions & 295 deletions

‎.github/mlc_config.json‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
{
2+
"ignorePatterns": [
3+
{
4+
"pattern": "^https://github.com/.*/actions"
5+
},
6+
{
7+
"pattern": "^https://github.com/.*/workflows/CI"
8+
}
9+
],
10+
"replacementPatterns": [],
11+
"httpHeaders": [],
12+
"timeout": "10s",
13+
"retryOn429": true,
14+
"retryCount": 3,
15+
"fallbackRetryDelay": "30s",
16+
"aliveStatusCodes": [200, 206]
17+
}

‎.github/workflows/ci.yml‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -115,6 +115,27 @@ jobs:
115115
- name: Run security audit
116116
run: cargo audit
117117

118+
docs:
119+
name: Documentation
120+
runs-on: ubuntu-latest
121+
steps:
122+
- uses: actions/checkout@v4
123+
124+
- name: Install Rust stable
125+
uses: dtolnay/rust-toolchain@stable
126+
127+
- name: Build documentation
128+
run: cargo doc --workspace --no-deps
129+
env:
130+
RUSTDOCFLAGS: "-D warnings"
131+
132+
- name: Check markdown links
133+
uses: gaurav-nelson/github-action-markdown-link-check@v1
134+
with:
135+
use-quiet-mode: 'yes'
136+
config-file: '.github/mlc_config.json'
137+
continue-on-error: true
138+
118139
build-release:
119140
name: Build Release
120141
runs-on: ${{ matrix.os }}

0 commit comments

Comments
 (0)