Skip to content

Commit 64fae33

Browse files
binarykclaude
andcommitted
feat: generate index.md homepage during /docs:init
The init workflow now creates: - {output_dir}/index.md - Documentation homepage with: - Product overview - Tech stack summary - Pages table (updated as docs are generated) - Quick links and getting started - Documentation generation commands - {output_dir}/images/ - Folder for screenshots Bumped version to 0.3.0 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
1 parent c3bed73 commit 64fae33

3 files changed

Lines changed: 73 additions & 3 deletions

File tree

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[project]
22
name = "aidocs-cli"
3-
version = "0.2.0"
3+
version = "0.3.0"
44
description = "AI-powered documentation generator for web applications. Install docs commands into your Claude Code project."
55
readme = "README.md"
66
license = { text = "MIT" }

src/aidocs_cli/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
"""AI-powered documentation generator CLI for Claude Code projects."""
22

3-
__version__ = "0.2.0"
3+
__version__ = "0.3.0"
44

55
from .cli import app
66

src/aidocs_cli/templates/workflows/init/workflow.md

Lines changed: 71 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -363,7 +363,75 @@ Create file: `.docsignore`
363363
/status
364364
```
365365

366-
### 5.2 Update README reminder
366+
### 5.3 Create Documentation Index (docs/index.md)
367+
368+
Create the output directory and generate an index file as the documentation homepage:
369+
370+
**Create directory:** `{output_directory}/` (e.g., `./docs/`)
371+
372+
**Create file:** `{output_directory}/index.md`
373+
374+
```markdown
375+
# {product_name} Documentation
376+
377+
Welcome to the {product_name} documentation. This guide covers all features and functionality of the application.
378+
379+
## Overview
380+
381+
{Brief description of the product based on project analysis and user input}
382+
383+
## Tech Stack
384+
385+
- **Frontend:** {frontend_framework}
386+
- **Backend:** {backend_framework}
387+
- **Database:** {database}
388+
389+
## Pages
390+
391+
| Page | Description | Status |
392+
|------|-------------|--------|
393+
| [Dashboard](./dashboard.md) | Main application dashboard | 🔜 Pending |
394+
| [Settings](./settings.md) | User and application settings | 🔜 Pending |
395+
396+
*Pages will be added as you run `/docs:generate` on each page.*
397+
398+
## Quick Links
399+
400+
- **Getting Started:** Start with the Dashboard to understand the main interface
401+
- **Configuration:** See Settings for customization options
402+
403+
## Generating Documentation
404+
405+
```bash
406+
# Generate docs for a specific page
407+
/docs:generate {base_url}/dashboard
408+
409+
# Update docs after code changes
410+
/docs:update --base main
411+
412+
# Generate all pages at once
413+
/docs:batch --discover
414+
```
415+
416+
## Documentation Info
417+
418+
- **Generated by:** [aidocs-cli](https://github.com/binarcode/aidocs-cli)
419+
- **Last initialized:** {date}
420+
- **Audience:** {audience}
421+
- **Style:** {tone}
422+
423+
---
424+
425+
*This index is automatically generated by `/docs:init`. Update it as you add more documentation.*
426+
```
427+
428+
**Also create images directory:** `{output_directory}/images/`
429+
430+
This prepares the folder structure for screenshots.
431+
432+
---
433+
434+
### 5.4 Update README reminder
367435

368436
Display to user:
369437
```
@@ -395,6 +463,8 @@ Generate documentation using Claude Code:
395463
📄 Created files:
396464
- docs-config.yaml (main configuration)
397465
- .docsignore (pages to skip)
466+
- {output_dir}/index.md (documentation homepage)
467+
- {output_dir}/images/ (screenshots folder)
398468
{if credentials saved}
399469
- .docs-auth (credentials - gitignored)
400470
{/if}

0 commit comments

Comments
 (0)