Skip to content

Commit 50c620b

Browse files
authored
Merge pull request #3202 from FMorschel/issue-template-docs
New docs issue template
2 parents 64612c9 + d999c83 commit 50c620b

File tree

2 files changed

+33
-0
lines changed

2 files changed

+33
-0
lines changed

.github/ISSUE_TEMPLATE/docs.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
name: 'Drift docs: Issue / Feature request'
3+
about: Create a report to help improve drift's docs
4+
title: ''
5+
labels: ['docs']
6+
assignees: ''
7+
---
8+
9+
**Description**
10+
11+
Thanks for taking the time to file an issue for drift's documentation website or dartdocs!
12+
13+
If you are looking for information that you feel is not sufficiently explained on the
14+
website (or too hard to find), please describe what the site is missing and, if possible,
15+
where you think the information should be added.
16+
17+
If something on a page appears to be wrong or outdated, please include a link to
18+
the relevant section and mention what didn't work (or possibly what should be
19+
written instead).
20+
21+
**Aditional info**
22+
23+
Write down any aditional info/discussion for this issue. If you think the documentation issue may be related to your drift version, please include the versions of `drift` you're using.
24+
Also, feel free to add screenshots or videos if they help explaining the documentation issue.
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
{% assign branch = site.github_branch | default: 'develop' %}
2+
{% assign subdir = site.github_subdir | default: '' %}
3+
{% assign edit_url = site.github_repo | append: '/edit/', branch, '/', subdir, page.source %}
4+
{% assign issues_url = site.github_repo | append: '/issues/new?template=docs.md&title=Documentation issue: ', page.title %}
5+
6+
<div class="td-page-meta ms-2 pb-1 pt-2 mb-0">
7+
<a href="{{ issues_url }}" class="td-page-meta--issue" target="_blank" rel="noopener"></i class="fa-solid fa-list-check fa-fw"> {{ "post_create_issue" | i18n }}</a>
8+
<a href="{{ edit_url }}" class="td-page-meta--edit" target="_blank" rel="noopener"><i class="fa-solid fa-pen-to-square fa-fw"></i> {{ "post_edit_this" | i18n }}</a>
9+
</div>

0 commit comments

Comments
 (0)