Skip to content

Commit 9c50e7d

Browse files
authored
docs: create issue template (#46)
* docs: add issue template * docs: make issue template a bit more elaborate * docs: add section in CONTRIBUTING for opening issues --------- Co-authored-by: dslovinsky <dslovinsky@users.noreply.github.com>
1 parent b2b4822 commit 9c50e7d

File tree

3 files changed

+36
-2
lines changed

3 files changed

+36
-2
lines changed
Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
name: Documentation Request
3+
about: Suggest improvements to Alchemy documentation
4+
title: "docs: <My Documentation Request>"
5+
labels: documentation, needs-triage
6+
assignees: ""
7+
---
8+
9+
**Is this a request for new documentation or updates to existing documentation?**
10+
11+
- [ ] New Documentation
12+
- [ ] Updates to Existing Documentation
13+
14+
**If updating existing documentation, please provide:**
15+
16+
- File path or URL of the documentation that needs updating
17+
- Proposed changes or improvements
18+
19+
**If requesting new documentation, please provide:**
20+
21+
- Type of content needed (API endpoint, RPC method, guide, etc.)
22+
- Key points or features that should be covered
23+
- Any specific examples or code snippets to include
24+
25+
**Additional Context**
26+
27+
- Related API endpoints or RPC methods (if applicable)
28+
- Screenshots or examples (if relevant)
29+
- Any specific formatting or style requirements
30+
- Links to related documentation or resources

CONTRIBUTING.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,10 @@ git push origin main
7474
- Ensure all checks pass before submitting
7575
- Follow the existing code style and formatting
7676

77+
## Creating Issues
78+
79+
Unsure how to make changes yourself? Feel free to open an issue using the appropriate template. Please fill out required fields and provide as much detail as possible to ensure contributors can be as helpful as possible.
80+
7781
## Code of Conduct
7882

7983
By participating in this project, you agree to abide by our Code of Conduct. Please be respectful and considerate of differing viewpoints and experiences.

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,14 @@ This repository contains the documentation for Alchemy's APIs and services. The
55
## Project Structure
66

77
```
8-
docs/
8+
/
99
├── src/
1010
│ ├── openapi/ # REST API definitions (OpenAPI)
1111
│ └── openrpc/ # JSON-RPC API definitions (OpenRPC)
1212
├── fern/
1313
│ ├── docs/ # Written documentation (MDX)
1414
│ └── docs.yml # Navigation and structure config
15-
└── docs/ # Generated documentation - Do NOT make changes here
15+
└── docs/ # Generated files - Do NOT make changes here
1616
```
1717

1818
## Getting Started

0 commit comments

Comments
 (0)