Skip to content

Commit a12a360

Browse files
rdmuellerrdmueller
authored
Merge pull request #17 from raifdmueller/feature/bash-implementation
feat: Add all improvements via local development
2 parents 1dccc32 + 6ab567d commit a12a360

11 files changed

+1295
-5
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
---
2+
name: 🐛 Bug Report
3+
about: Report a bug or issue with existing prompts or website
4+
title: '[BUG] '
5+
labels: ['bug']
6+
assignees: ''
7+
---
8+
9+
## 🐛 Bug Description
10+
<!-- A clear and concise description of what the bug is -->
11+
12+
## 📍 Location
13+
<!-- Where did you encounter this bug? -->
14+
- [ ] Specific prompt:
15+
- [ ] Website page:
16+
- [ ] Documentation:
17+
- [ ] Other:
18+
19+
## 🔄 Steps to Reproduce
20+
1. Go to '...'
21+
2. Use prompt with '...'
22+
3. Expected '...'
23+
4. See error
24+
25+
## 💭 Expected Behavior
26+
<!-- What you expected to happen -->
27+
28+
## 🚫 Actual Behavior
29+
<!-- What actually happened -->
30+
31+
## 🤖 LLM Information
32+
<!-- If the issue is with a prompt -->
33+
- **LLM Used**: [ ] Claude Sonnet | [ ] Claude Opus | [ ] ChatGPT 4 | [ ] Other:
34+
- **Prompt Input**:
35+
<!-- Please share what you entered into the LLM -->
36+
37+
## 🖥️ Environment
38+
<!-- If the issue is with the website -->
39+
- **Browser**:
40+
- **Device**: [ ] Desktop | [ ] Mobile | [ ] Tablet
41+
- **Operating System**:
42+
43+
## 📎 Additional Context
44+
<!-- Add any other context, screenshots, or examples -->
45+
46+
## ✅ Checklist
47+
- [ ] I have searched existing issues for duplicates
48+
- [ ] I have provided clear steps to reproduce
49+
- [ ] I have tested with the latest version of the prompt/website

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
---
2+
name: 🚀 Feature Request
3+
about: Suggest an improvement or new feature
4+
title: '[FEATURE] '
5+
labels: ['enhancement']
6+
assignees: ''
7+
---
8+
9+
## 🎯 Feature Description
10+
<!-- A clear and concise description of the feature you'd like to see -->
11+
12+
## 💡 Motivation & Use Case
13+
<!-- Why is this feature needed? What problem does it solve? -->
14+
15+
## 📋 Proposed Solution
16+
<!-- Describe your preferred solution in detail -->
17+
18+
## 🔄 User Story
19+
<!-- As a [type of user], I want [goal] so that [reason] -->
20+
21+
## 🎨 Mockups or Examples
22+
<!-- If applicable, add sketches, mockups, or examples -->
23+
24+
## 📚 Alternative Solutions
25+
<!-- Describe alternatives you've considered -->
26+
27+
## 🛠️ Implementation Ideas
28+
<!-- Optional: Technical suggestions for implementation -->
29+
30+
## 📊 Acceptance Criteria
31+
<!-- What would make this feature complete? -->
32+
- [ ]
33+
- [ ]
34+
- [ ]
35+
36+
## 🏷️ Feature Category
37+
- [ ] New Prompt
38+
- [ ] Prompt Improvement
39+
- [ ] Website Enhancement
40+
- [ ] Documentation
41+
- [ ] Integration
42+
- [ ] Other:
43+
44+
## 🎯 Priority
45+
- [ ] Critical
46+
- [ ] High
47+
- [ ] Medium
48+
- [ ] Low
49+
- [ ] Nice to have
50+
51+
## ✅ Checklist
52+
- [ ] I have searched existing issues for similar requests
53+
- [ ] I have provided clear use cases and motivation
54+
- [ ] I have considered implementation feasibility

‎.github/ISSUE_TEMPLATE/prompt_suggestion.md‎

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
---
2+
name: 🤖 New Prompt Suggestion
3+
about: Suggest a new prompt for the collection
4+
title: '[PROMPT] '
5+
labels: ['new-prompt', 'community']
6+
assignees: ''
7+
---
8+
9+
## 🎯 Prompt Purpose
10+
<!-- What should this prompt help architects accomplish? -->
11+
12+
## 🏗️ Architecture Domain
13+
<!-- Which area of architecture does this address? -->
14+
- [ ] Software Architecture
15+
- [ ] Data Architecture
16+
- [ ] Cloud Architecture
17+
- [ ] Security Architecture
18+
- [ ] Enterprise Architecture
19+
- [ ] Solution Architecture
20+
- [ ] Other:
21+
22+
## 📋 Target Methodology
23+
<!-- Which frameworks or methodologies should this support? -->
24+
- [ ] arc42
25+
- [ ] TOGAF
26+
- [ ] Zachman Framework
27+
- [ ] C4 Model
28+
- [ ] Domain-Driven Design
29+
- [ ] Microservices
30+
- [ ] Other:
31+
32+
## 👥 Target Audience
33+
<!-- Who would primarily use this prompt? -->
34+
- [ ] Solution Architects
35+
- [ ] Software Architects
36+
- [ ] Enterprise Architects
37+
- [ ] Technical Leads
38+
- [ ] Product Managers
39+
- [ ] Development Teams
40+
- [ ] Other:
41+
42+
## 💼 Use Cases
43+
<!-- Specific scenarios where this prompt would be valuable -->
44+
1.
45+
2.
46+
3.
47+
48+
## 📊 Expected Output Format
49+
<!-- What format should the LLM generate? -->
50+
- [ ] AsciiDoc document
51+
- [ ] PlantUML diagram
52+
- [ ] Structured table
53+
- [ ] Decision matrix
54+
- [ ] Other:
55+
56+
## 🔗 Integration Points
57+
<!-- How would this work with existing prompts? -->
58+
59+
## 💡 Prompt Ideas
60+
<!-- If you have initial ideas for the prompt structure -->
61+
62+
## 📚 Reference Materials
63+
<!-- Any methodologies, templates, or resources to reference -->
64+
65+
## ✅ Contribution Intent
66+
- [ ] I'd like to contribute this prompt myself
67+
- [ ] I'm suggesting this for others to implement
68+
- [ ] I can help with testing and validation
69+
70+
## 📖 Additional Context
71+
<!-- Any other information that would be helpful -->
72+
73+
---
74+
75+
**Community Guidelines Reminder:**
76+
- Prompts should be tested with multiple LLMs
77+
- Output should follow established architectural practices
78+
- Include clear examples and validation criteria
79+
- Consider integration with docToolchain workflow

‎.github/pull_request_template.md‎

Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
# Pull Request
2+
3+
## 📋 Summary
4+
<!-- Brief description of what this PR accomplishes -->
5+
6+
## 🔄 Type of Change
7+
- [ ] 🐛 Bug fix (non-breaking change which fixes an issue)
8+
- [ ] ✨ New feature (non-breaking change which adds functionality)
9+
- [ ] 💥 Breaking change (fix or feature that would cause existing functionality to not work as expected)
10+
- [ ] 📚 Documentation update
11+
- [ ] 🎨 Style/formatting changes
12+
- [ ] ♻️ Code refactoring
13+
- [ ] 🧪 Adding or updating tests
14+
15+
## 🎯 Changes Made
16+
<!-- Detailed list of changes -->
17+
-
18+
-
19+
-
20+
21+
## 🧪 Testing
22+
<!-- How have you tested these changes? -->
23+
24+
### Prompt Testing (if applicable)
25+
- [ ] Tested with Claude Sonnet
26+
- [ ] Tested with Claude Opus
27+
- [ ] Tested with ChatGPT 4
28+
- [ ] Output matches expected format
29+
- [ ] Examples work correctly
30+
31+
### Website Testing (if applicable)
32+
- [ ] Site generates correctly with `./dtcw generateSite`
33+
- [ ] AsciiDoc validates with `./dtcw generateHTML`
34+
- [ ] Navigation works properly
35+
- [ ] Mobile responsive design verified
36+
- [ ] All links functional
37+
38+
## 📸 Screenshots
39+
<!-- If applicable, add screenshots to help explain your changes -->
40+
41+
## 📚 Documentation
42+
- [ ] Updated relevant documentation
43+
- [ ] Added/updated examples
44+
- [ ] Updated README if needed
45+
- [ ] Added tests if applicable
46+
47+
## 🔗 Related Issues
48+
<!-- Link any related issues -->
49+
Fixes #
50+
Relates to #
51+
52+
## ✅ Checklist
53+
- [ ] My code follows the project's style guidelines
54+
- [ ] I have performed a self-review of my own changes
55+
- [ ] I have commented my code, particularly in hard-to-understand areas
56+
- [ ] I have made corresponding changes to the documentation
57+
- [ ] My changes generate no new warnings
58+
- [ ] I have tested my changes thoroughly
59+
- [ ] All existing tests pass
60+
61+
## 🎯 Target Audience Impact
62+
<!-- Who benefits from these changes? -->
63+
- [ ] Architecture practitioners
64+
- [ ] Documentation creators
65+
- [ ] Website users
66+
- [ ] Contributors/developers
67+
- [ ] LLM users
68+
69+
## 📊 Quality Metrics
70+
<!-- For prompt changes -->
71+
- **Clarity**: How clear and unambiguous are the instructions?
72+
- **Completeness**: Does it cover all necessary aspects?
73+
- **Consistency**: Does it align with other prompts in style and format?
74+
- **Testability**: Can the output be validated effectively?
75+
76+
## 🚀 Deployment Notes
77+
<!-- Any special considerations for deploying these changes -->
78+
79+
---
80+
81+
**Reviewer Notes:**
82+
- Please test prompts with your preferred LLM
83+
- Verify website changes render correctly
84+
- Check that examples are complete and realistic
85+
- Ensure integration with existing prompts works well

‎CLEANUP_PLAN.md‎

Lines changed: 111 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,111 @@
1+
# Repository Structure Cleanup Plan
2+
3+
## Current Issues
4+
5+
### 1. Duplicate Content Structure
6+
- `/prompts/` - Contains original Markdown prompts
7+
- `/src/docs/Prompts/` - Contains AsciiDoc stubs that reference Markdown files
8+
- Inconsistent file formats and incomplete documentation
9+
10+
### 2. Missing Integration
11+
- Examples referenced but don't exist
12+
- Broken includes in AsciiDoc files
13+
- Inconsistent navigation
14+
15+
## Proposed Solution
16+
17+
### Phase 1: Immediate (High Priority) ✅
18+
- [x] Create comprehensive examples in `/src/docs/examples/`
19+
- [x] Add navigation component for website
20+
- [x] Create complete AsciiDoc versions of prompts
21+
- [x] Add CONTRIBUTING.md
22+
23+
### Phase 2: Structure Cleanup (Medium Priority)
24+
- [ ] Keep `/prompts/` as source of truth for Markdown versions
25+
- [ ] Complete all AsciiDoc files in `/src/docs/Prompts/`
26+
- [ ] Add proper includes and cross-references
27+
- [ ] Create integration documentation
28+
29+
### Phase 3: Enhancement (Lower Priority)
30+
- [ ] Add GitHub issue templates
31+
- [ ] Implement automated link checking
32+
- [ ] Add search functionality
33+
- [ ] Create video tutorials
34+
35+
## File Organization Strategy
36+
37+
```
38+
LLM-Prompts/
39+
├── prompts/ # Source Markdown prompts (keep)
40+
│ ├── Architecture-Communication-Canvas.md
41+
│ ├── Architecture-Decision-Record.md
42+
│ └── ...
43+
├── src/docs/ # docToolchain website content
44+
│ ├── landingpage.gsp # New improved landing page ✅
45+
│ ├── navigation.adoc # Navigation component ✅
46+
│ ├── examples/ # Complete examples ✅
47+
│ │ ├── architecture-communication-canvas-example.adoc
48+
│ │ ├── architecture-decision-record-example.adoc
49+
│ │ └── quality-scenarios-example.adoc
50+
│ ├── descriptions/ # Keep existing descriptions
51+
│ └── Prompts/ # Complete AsciiDoc versions
52+
│ ├── 10-Intro.adoc
53+
│ ├── 20-ACC.adoc # Completed ✅
54+
│ ├── 30-ADR.adoc
55+
│ └── ...
56+
├── .github/
57+
│ ├── workflows/
58+
│ │ └── gh-pages.yml # Keep existing
59+
│ ├── ISSUE_TEMPLATE/ # Add GitHub templates
60+
│ │ ├── bug_report.md
61+
│ │ ├── feature_request.md
62+
│ │ └── prompt_suggestion.md
63+
│ └── pull_request_template.md
64+
├── README.adoc # Keep as main documentation
65+
├── CONTRIBUTING.md # Added ✅
66+
├── LICENSE # Add license file
67+
└── docToolchainConfig.groovy # Keep existing config
68+
```
69+
70+
## Benefits of This Approach
71+
72+
1. **Clear Separation**: Markdown for development, AsciiDoc for publication
73+
2. **Maintainability**: Single source of truth for each format
74+
3. **User Experience**: Complete website with examples and navigation
75+
4. **Community**: Clear contribution guidelines and templates
76+
5. **Integration**: Proper docToolchain workflow
77+
78+
## Implementation Steps
79+
80+
### Immediate Actions Completed ✅
81+
- Landing page redesigned with modern, engaging interface
82+
- Navigation component created for consistent site navigation
83+
- Example outputs created for major prompts
84+
- CONTRIBUTING.md with comprehensive guidelines
85+
- Complete AsciiDoc version of ACC prompt with interactive features
86+
87+
### Next Actions Needed
88+
1. Complete remaining AsciiDoc prompt files (ADR, Quality Scenarios, etc.)
89+
2. Add GitHub issue and PR templates
90+
3. Create LICENSE file
91+
4. Add automated link checking workflow
92+
5. Update main README to reflect new structure
93+
94+
## Quality Assurance
95+
96+
### Testing Checklist
97+
- [ ] All AsciiDoc files generate correctly with docToolchain
98+
- [ ] Navigation works on all pages
99+
- [ ] Examples display properly
100+
- [ ] Copy-to-clipboard functionality works
101+
- [ ] Mobile responsiveness verified
102+
- [ ] All internal links functional
103+
104+
### Validation Process
105+
1. Test website generation locally: `./dtcw generateSite`
106+
2. Validate AsciiDoc syntax: `./dtcw generateHTML`
107+
3. Check responsive design on multiple screen sizes
108+
4. Test prompt functionality with actual LLMs
109+
5. Verify GitHub Pages deployment
110+
111+
This structured approach will transform the repository into a professional, user-friendly resource while maintaining backward compatibility.

0 commit comments

Comments
 (0)