docToolchain / docToolchain/LLM-Prompts

πŸš€ Add docToolchain integration with GitHub Pages deployment

Open
#13 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
Groovy
Stars
36
Forks
6
PR merge metrics
No merged PRs in 30d

Description

## 🎯 Objective

Add professional documentation generation and deployment to the LLM-Prompts repository using docToolchain with GitHub Pages integration.

## πŸ›  Proposed Implementation

### 1. docToolchain Installation
- Add `dtcw` wrapper script for modern docToolchain installation
- Create `docToolchainConfig.groovy` with microsite configuration
- Set up proper AsciiDoc documentation structure in `src/docs/`

### 2. Documentation Structure
- Convert existing Markdown prompts to AsciiDoc format
- Create master document `src/docs/index.adoc` that includes all prompts
- Organize prompts in `src/docs/prompts/` directory
- Add images directory for diagrams and assets

### 3. GitHub Actions Workflow
- Automated building on every push to `main` branch
- Use `generateSite` for professional microsite generation
- Deploy to GitHub Pages automatically
- Generate both HTML website and PDF documentation
- Cache dependencies for faster builds

### 4. Professional Documentation Website
**Benefits of `generateSite` over basic HTML:**
- βœ… **Enhanced Navigation**: Full site navigation with menu structure
- βœ… **Search Functionality**: Built-in search capabilities
- βœ… **Responsive Design**: Mobile-friendly documentation
- βœ… **Professional Styling**: Modern, clean UI
- βœ… **Multi-page Structure**: Better organization than single-page docs

## πŸ“ File Structure (Proposed)

```
docToolchain/LLM-Prompts/
β”œβ”€β”€ dtcw # docToolchain wrapper script
β”œβ”€β”€ docToolchainConfig.groovy # docToolchain configuration
β”œβ”€β”€ .github/
β”‚ └── workflows/
β”‚ └── docs.yml # GitHub Actions workflow
β”œβ”€β”€ src/
β”‚ └── docs/
β”‚ β”œβ”€β”€ index.adoc # Master documentation file
β”‚ β”œβ”€β”€ images/ # Images and diagrams
β”‚ └── prompts/ # Individual prompt files
β”‚ β”œβ”€β”€ architecture-communication-canvas.adoc
β”‚ β”œβ”€β”€ architecture-decision-record.adoc
β”‚ β”œβ”€β”€ quality-scenarios-builder.adoc
β”‚ β”œβ”€β”€ risk-assessment-matrix.adoc
β”‚ β”œβ”€β”€ technical-debt-tracker.adoc
β”‚ └── arc42-chapter-generator.adoc
└── build/ # Generated documentation (gitignored)
└── microsite/ # Professional website output
```

## 🎯 Expected Outcome

1. **Professional Documentation Website**: Available at `https://doctoolchain.github.io/LLM-Prompts/`
2. **Automated Deployment**: Documentation updates automatically on every push
3. **Multiple Formats**: Both web and PDF documentation available
4. **Better User Experience**: Modern website with navigation, search, and responsive design
5. **Easy Maintenance**: Standard docToolchain workflow for future updates

## πŸš€ Benefits for the Project

- **Professional Appearance**: Showcase LLM prompts in a polished documentation site
- **Better Discoverability**: Search functionality helps users find relevant prompts
- **Mobile-Friendly**: Works well on all devices
- **Easy Contributing**: Standard docs-as-code workflow
- **PDF Export**: Downloadable documentation for offline use

## 🀝 Implementation Plan

1. Create pull request with docToolchain setup
2. Add GitHub Actions workflow for automated building
3. Enable GitHub Pages in repository settings
4. Test and refine the documentation generation
5. Update README with new documentation links

This would make the LLM-Prompts collection much more professional and user-friendly! πŸŽ‰

---
**Technical Note**: Using the modern `dtcw` wrapper script ensures easy installation and maintenance, while `generateSite` creates a superior user experience compared to basic HTML generation.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.