Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 49 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
---
name: 🐛 Bug Report
about: Report a bug or issue with existing prompts or website
title: '[BUG] '
labels: ['bug']
assignees: ''
---

## 🐛 Bug Description
<!-- A clear and concise description of what the bug is -->

## 📍 Location
<!-- Where did you encounter this bug? -->
- [ ] Specific prompt:
- [ ] Website page:
- [ ] Documentation:
- [ ] Other:

## 🔄 Steps to Reproduce
1. Go to '...'
2. Use prompt with '...'
3. Expected '...'
4. See error

## 💭 Expected Behavior
<!-- What you expected to happen -->

## 🚫 Actual Behavior
<!-- What actually happened -->

## 🤖 LLM Information
<!-- If the issue is with a prompt -->
- **LLM Used**: [ ] Claude Sonnet | [ ] Claude Opus | [ ] ChatGPT 4 | [ ] Other:
- **Prompt Input**:
<!-- Please share what you entered into the LLM -->

## 🖥️ Environment
<!-- If the issue is with the website -->
- **Browser**:
- **Device**: [ ] Desktop | [ ] Mobile | [ ] Tablet
- **Operating System**:

## 📎 Additional Context
<!-- Add any other context, screenshots, or examples -->

## ✅ Checklist
- [ ] I have searched existing issues for duplicates
- [ ] I have provided clear steps to reproduce
- [ ] I have tested with the latest version of the prompt/website
54 changes: 54 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
---
name: 🚀 Feature Request
about: Suggest an improvement or new feature
title: '[FEATURE] '
labels: ['enhancement']
assignees: ''
---

## 🎯 Feature Description
<!-- A clear and concise description of the feature you'd like to see -->

## 💡 Motivation & Use Case
<!-- Why is this feature needed? What problem does it solve? -->

## 📋 Proposed Solution
<!-- Describe your preferred solution in detail -->

## 🔄 User Story
<!-- As a [type of user], I want [goal] so that [reason] -->

## 🎨 Mockups or Examples
<!-- If applicable, add sketches, mockups, or examples -->

## 📚 Alternative Solutions
<!-- Describe alternatives you've considered -->

## 🛠️ Implementation Ideas
<!-- Optional: Technical suggestions for implementation -->

## 📊 Acceptance Criteria
<!-- What would make this feature complete? -->
- [ ]
- [ ]
- [ ]

## 🏷️ Feature Category
- [ ] New Prompt
- [ ] Prompt Improvement
- [ ] Website Enhancement
- [ ] Documentation
- [ ] Integration
- [ ] Other:

## 🎯 Priority
- [ ] Critical
- [ ] High
- [ ] Medium
- [ ] Low
- [ ] Nice to have

## ✅ Checklist
- [ ] I have searched existing issues for similar requests
- [ ] I have provided clear use cases and motivation
- [ ] I have considered implementation feasibility
79 changes: 79 additions & 0 deletions .github/ISSUE_TEMPLATE/prompt_suggestion.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
---
name: 🤖 New Prompt Suggestion
about: Suggest a new prompt for the collection
title: '[PROMPT] '
labels: ['new-prompt', 'community']
assignees: ''
---

## 🎯 Prompt Purpose
<!-- What should this prompt help architects accomplish? -->

## 🏗️ Architecture Domain
<!-- Which area of architecture does this address? -->
- [ ] Software Architecture
- [ ] Data Architecture
- [ ] Cloud Architecture
- [ ] Security Architecture
- [ ] Enterprise Architecture
- [ ] Solution Architecture
- [ ] Other:

## 📋 Target Methodology
<!-- Which frameworks or methodologies should this support? -->
- [ ] arc42
- [ ] TOGAF
- [ ] Zachman Framework
- [ ] C4 Model
- [ ] Domain-Driven Design
- [ ] Microservices
- [ ] Other:

## 👥 Target Audience
<!-- Who would primarily use this prompt? -->
- [ ] Solution Architects
- [ ] Software Architects
- [ ] Enterprise Architects
- [ ] Technical Leads
- [ ] Product Managers
- [ ] Development Teams
- [ ] Other:

## 💼 Use Cases
<!-- Specific scenarios where this prompt would be valuable -->
1.
2.
3.

## 📊 Expected Output Format
<!-- What format should the LLM generate? -->
- [ ] AsciiDoc document
- [ ] PlantUML diagram
- [ ] Structured table
- [ ] Decision matrix
- [ ] Other:

## 🔗 Integration Points
<!-- How would this work with existing prompts? -->

## 💡 Prompt Ideas
<!-- If you have initial ideas for the prompt structure -->

## 📚 Reference Materials
<!-- Any methodologies, templates, or resources to reference -->

## ✅ Contribution Intent
- [ ] I'd like to contribute this prompt myself
- [ ] I'm suggesting this for others to implement
- [ ] I can help with testing and validation

## 📖 Additional Context
<!-- Any other information that would be helpful -->

---

**Community Guidelines Reminder:**
- Prompts should be tested with multiple LLMs
- Output should follow established architectural practices
- Include clear examples and validation criteria
- Consider integration with docToolchain workflow
85 changes: 85 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
# Pull Request

## 📋 Summary
<!-- Brief description of what this PR accomplishes -->

## 🔄 Type of Change
- [ ] 🐛 Bug fix (non-breaking change which fixes an issue)
- [ ] ✨ New feature (non-breaking change which adds functionality)
- [ ] 💥 Breaking change (fix or feature that would cause existing functionality to not work as expected)
- [ ] 📚 Documentation update
- [ ] 🎨 Style/formatting changes
- [ ] ♻️ Code refactoring
- [ ] 🧪 Adding or updating tests

## 🎯 Changes Made
<!-- Detailed list of changes -->
-
-
-

## 🧪 Testing
<!-- How have you tested these changes? -->

### Prompt Testing (if applicable)
- [ ] Tested with Claude Sonnet
- [ ] Tested with Claude Opus
- [ ] Tested with ChatGPT 4
- [ ] Output matches expected format
- [ ] Examples work correctly

### Website Testing (if applicable)
- [ ] Site generates correctly with `./dtcw generateSite`
- [ ] AsciiDoc validates with `./dtcw generateHTML`
- [ ] Navigation works properly
- [ ] Mobile responsive design verified
- [ ] All links functional

## 📸 Screenshots
<!-- If applicable, add screenshots to help explain your changes -->

## 📚 Documentation
- [ ] Updated relevant documentation
- [ ] Added/updated examples
- [ ] Updated README if needed
- [ ] Added tests if applicable

## 🔗 Related Issues
<!-- Link any related issues -->
Fixes #
Relates to #

## ✅ Checklist
- [ ] My code follows the project's style guidelines
- [ ] I have performed a self-review of my own changes
- [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] I have made corresponding changes to the documentation
- [ ] My changes generate no new warnings
- [ ] I have tested my changes thoroughly
- [ ] All existing tests pass

## 🎯 Target Audience Impact
<!-- Who benefits from these changes? -->
- [ ] Architecture practitioners
- [ ] Documentation creators
- [ ] Website users
- [ ] Contributors/developers
- [ ] LLM users

## 📊 Quality Metrics
<!-- For prompt changes -->
- **Clarity**: How clear and unambiguous are the instructions?
- **Completeness**: Does it cover all necessary aspects?
- **Consistency**: Does it align with other prompts in style and format?
- **Testability**: Can the output be validated effectively?

## 🚀 Deployment Notes
<!-- Any special considerations for deploying these changes -->

---

**Reviewer Notes:**
- Please test prompts with your preferred LLM
- Verify website changes render correctly
- Check that examples are complete and realistic
- Ensure integration with existing prompts works well
111 changes: 111 additions & 0 deletions CLEANUP_PLAN.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,111 @@
# Repository Structure Cleanup Plan

## Current Issues

### 1. Duplicate Content Structure
- `/prompts/` - Contains original Markdown prompts
- `/src/docs/Prompts/` - Contains AsciiDoc stubs that reference Markdown files
- Inconsistent file formats and incomplete documentation

### 2. Missing Integration
- Examples referenced but don't exist
- Broken includes in AsciiDoc files
- Inconsistent navigation

## Proposed Solution

### Phase 1: Immediate (High Priority) ✅
- [x] Create comprehensive examples in `/src/docs/examples/`
- [x] Add navigation component for website
- [x] Create complete AsciiDoc versions of prompts
- [x] Add CONTRIBUTING.md

### Phase 2: Structure Cleanup (Medium Priority)
- [ ] Keep `/prompts/` as source of truth for Markdown versions
- [ ] Complete all AsciiDoc files in `/src/docs/Prompts/`
- [ ] Add proper includes and cross-references
- [ ] Create integration documentation

### Phase 3: Enhancement (Lower Priority)
- [ ] Add GitHub issue templates
- [ ] Implement automated link checking
- [ ] Add search functionality
- [ ] Create video tutorials

## File Organization Strategy

```
LLM-Prompts/
├── prompts/ # Source Markdown prompts (keep)
│ ├── Architecture-Communication-Canvas.md
│ ├── Architecture-Decision-Record.md
│ └── ...
├── src/docs/ # docToolchain website content
│ ├── landingpage.gsp # New improved landing page ✅
│ ├── navigation.adoc # Navigation component ✅
│ ├── examples/ # Complete examples ✅
│ │ ├── architecture-communication-canvas-example.adoc
│ │ ├── architecture-decision-record-example.adoc
│ │ └── quality-scenarios-example.adoc
│ ├── descriptions/ # Keep existing descriptions
│ └── Prompts/ # Complete AsciiDoc versions
│ ├── 10-Intro.adoc
│ ├── 20-ACC.adoc # Completed ✅
│ ├── 30-ADR.adoc
│ └── ...
├── .github/
│ ├── workflows/
│ │ └── gh-pages.yml # Keep existing
│ ├── ISSUE_TEMPLATE/ # Add GitHub templates
│ │ ├── bug_report.md
│ │ ├── feature_request.md
│ │ └── prompt_suggestion.md
│ └── pull_request_template.md
├── README.adoc # Keep as main documentation
├── CONTRIBUTING.md # Added ✅
├── LICENSE # Add license file
└── docToolchainConfig.groovy # Keep existing config
```

## Benefits of This Approach

1. **Clear Separation**: Markdown for development, AsciiDoc for publication
2. **Maintainability**: Single source of truth for each format
3. **User Experience**: Complete website with examples and navigation
4. **Community**: Clear contribution guidelines and templates
5. **Integration**: Proper docToolchain workflow

## Implementation Steps

### Immediate Actions Completed ✅
- Landing page redesigned with modern, engaging interface
- Navigation component created for consistent site navigation
- Example outputs created for major prompts
- CONTRIBUTING.md with comprehensive guidelines
- Complete AsciiDoc version of ACC prompt with interactive features

### Next Actions Needed
1. Complete remaining AsciiDoc prompt files (ADR, Quality Scenarios, etc.)
2. Add GitHub issue and PR templates
3. Create LICENSE file
4. Add automated link checking workflow
5. Update main README to reflect new structure

## Quality Assurance

### Testing Checklist
- [ ] All AsciiDoc files generate correctly with docToolchain
- [ ] Navigation works on all pages
- [ ] Examples display properly
- [ ] Copy-to-clipboard functionality works
- [ ] Mobile responsiveness verified
- [ ] All internal links functional

### Validation Process
1. Test website generation locally: `./dtcw generateSite`
2. Validate AsciiDoc syntax: `./dtcw generateHTML`
3. Check responsive design on multiple screen sizes
4. Test prompt functionality with actual LLMs
5. Verify GitHub Pages deployment

This structured approach will transform the repository into a professional, user-friendly resource while maintaining backward compatibility.
Loading
Loading