Skip to content

Commit c511e10

Browse files
authored
Update issue templates (docs)
Update issue templates (docs)
1 parent 3c2e930 commit c511e10

File tree

1 file changed

+57
-0
lines changed

1 file changed

+57
-0
lines changed

.github/ISSUE_TEMPLATE/docs-issue.md

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
---
2+
name: Docs issue
3+
about: Report a typo, outdated info, unclear instructions, or missing documentation
4+
title: "[Docs]:"
5+
labels: documentation, triage
6+
assignees: ''
7+
8+
---
9+
10+
<!--
11+
💡 Tip: If you're suggesting a fix, include the markdown you'd use to update the doc.
12+
You can also preview changes locally by running:
13+
cd docs && make serve
14+
This helps ensure formatting and links render correctly.
15+
-->
16+
17+
### 📚 Documentation Issue Summary
18+
What's wrong or missing?
19+
20+
---
21+
22+
### 📍 Location of the Problem
23+
Please link to the affected page, file, or section (if possible):
24+
25+
> Example: `docs/docs/using/agents/crewai.md` or `./README.md`
26+
> or https://ibm.github.io/mcp-context-forge/overview/features/
27+
28+
---
29+
30+
### ✏️ Type of Issue
31+
32+
- [ ] Typo or formatting issue
33+
- [ ] Outdated or incorrect information
34+
- [ ] Missing explanation or example
35+
- [ ] Unclear instructions
36+
- [ ] Other (explain below)
37+
38+
---
39+
40+
### 💡 Suggested Fix or Clarification (optional)
41+
If you know how to fix it, describe it, paste a markdown snippet, or link a reference.
42+
43+
---
44+
45+
### 🧠 Environment (optional)
46+
If related to platform-specific behavior (e.g. a command not working on macOS), describe that here:
47+
48+
| Key | Value |
49+
|-----|-------|
50+
| Docs version | `e.g. latest, main, v0.9.0` |
51+
| Platform | `e.g. Windows, macOS, Linux` |
52+
| Docs build method | `e.g. mkdocs locally, GitHub Pages` |
53+
54+
---
55+
56+
### 🧩 Additional Notes (optional)
57+
Any screenshots, logs, or related issues?

0 commit comments

Comments
 (0)