Skip to content

Commit 8712f48

Browse files
committed
Various git improvements
1 parent 918381b commit 8712f48

3 files changed

Lines changed: 6 additions & 76 deletions

File tree

.github/ISSUE_TEMPLATE/documentation_improvement.md

Lines changed: 3 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -15,26 +15,14 @@ Please specify which part of the documentation needs improvement:
1515
- **Section**:
1616
- **Specific endpoint** (if applicable):
1717

18-
### 🎯 Type of Improvement
19-
- [ ] Missing information
20-
- [ ] Unclear explanation
21-
- [ ] Outdated content
22-
- [ ] Missing code examples
23-
- [ ] Missing language examples
24-
- [ ] Formatting issues
25-
- [ ] Other: ___________
26-
2718
### 💡 Suggested Improvement
2819
A clear and concise description of what you'd like to see improved.
2920

30-
### 🔍 Current Content (if applicable)
21+
### 🔍 Current Content
3122
Quote or describe the current content that needs improvement.
3223

33-
### ✨ Proposed Content
24+
### ✨ Proposed Content
3425
Describe or provide the improved content you'd like to see.
3526

3627
### 🎁 Additional Value
37-
Explain how this improvement would help other developers.
38-
39-
### 📋 Additional Context
40-
Add any other context, links, or screenshots about the improvement suggestion.
28+
Explain how this improvement would help other developers.

.github/pull_request_template.md

Lines changed: 1 addition & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,7 @@
11
## 📋 Pull Request Description
22

3-
### 🎯 Type of Change
4-
- [ ] Bug fix (non-breaking change which fixes an issue)
5-
- [ ] New feature (non-breaking change which adds functionality)
6-
- [ ] Documentation improvement
7-
- [ ] Code example update
8-
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
9-
103
### 📖 What does this PR do?
114
A clear and concise description of what this pull request accomplishes.
125

136
### 🔍 Related Issue
14-
Fixes #(issue number) or Closes #(issue number)
15-
16-
### 📍 Changes Made
17-
- [ ] Updated documentation content
18-
- [ ] Added/updated code examples
19-
- [ ] Fixed typos or formatting
20-
- [ ] Added new API endpoint documentation
21-
- [ ] Updated existing API endpoint documentation
22-
- [ ] Other: ___________
23-
24-
### 🧪 Testing
25-
- [ ] I have tested all code examples
26-
- [ ] Documentation builds without errors (`npm run build`)
27-
- [ ] All links work correctly
28-
- [ ] Multi-language examples are consistent
29-
- [ ] Changes are responsive on different screen sizes
30-
31-
### 📸 Screenshots (if applicable)
32-
Add screenshots to show visual changes.
33-
34-
### 📋 Checklist
35-
- [ ] My code follows the style guidelines of this project
36-
- [ ] I have performed a self-review of my changes
37-
- [ ] I have commented my code, particularly in hard-to-understand areas
38-
- [ ] My changes generate no new warnings
39-
- [ ] I have added examples that prove my fix is effective or that my feature works
40-
- [ ] New and existing tests pass locally with my changes
41-
42-
### 📝 Additional Notes
43-
Any additional information or context about the pull request.
7+
Fixes #(issue number) or Closes #(issue number)

CONTRIBUTING.md

Lines changed: 2 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -101,13 +101,6 @@ When adding or updating code examples:
101101
- **Error Handling**: Show proper error handling where relevant
102102
- **Security**: Emphasize security best practices
103103

104-
### File Structure
105-
106-
- **Client API**: `/docs/api/client/` - User-facing API endpoints
107-
- **Application API**: `/docs/api/application/` - Admin API endpoints
108-
- **WebSocket API**: `/docs/api/websocket.md` - Real-time connections
109-
- **Guides**: `/docs/` - General guides and concepts
110-
111104
## 🔧 Development Setup
112105

113106
### Prerequisites
@@ -134,9 +127,7 @@ npm run validate:codetabs
134127

135128
### Testing
136129
- Verify some code examples before submitting
137-
- Verify responsive design on different screen sizes
138130
- Check that internal links work correctly
139-
- Ensure search functionality works with new content
140131

141132
## 🎨 Style Guide
142133

@@ -166,21 +157,8 @@ Each endpoint should include:
166157

167158
### Getting Help
168159
- **Questions**: Use [GitHub Discussions](https://github.com/netvpx/pterodactyl-api-docs/discussions)
169-
- **Pterodactyl Chat**: Join the [Pterodactyl Discord](https://discord.gg/pterodactyl)
170-
- **NETVPX Support**: [Contact us](https://netvpx.com/support) for hosting-related questions
171-
172-
## 📋 Pull Request Checklist
173-
174-
Before submitting your PR, ensure:
175-
176-
- [ ] The code examples are working
177-
- [ ] Multi-language examples are consistent (all 8 languages)
178-
- [ ] CodeTabs component is used for all API examples
179-
- [ ] Documentation builds without errors (`npm run build`)
180-
- [ ] CodeTabs validation passes (`npm run validate:codetabs`)
181-
- [ ] Links are working and point to correct locations
182-
- [ ] New content follows existing style and format
183-
- [ ] Changes are focused and related to a single improvement
160+
- **Pterodactyl Chat**: Join the [Pterodactyl Discord](https://discord.gg/pterodactyl) which has a [dedicated API & Modding channel](https://discord.com/channels/122900397965705216/936744899787784282)
161+
- **NETVPX Support**: [Contact us](https://netvpx.com/support) for other questionst
184162

185163
## 🚀 Release Process
186164

0 commit comments

Comments
 (0)