Skip to content
This repository was archived by the owner on Feb 21, 2024. It is now read-only.

Commit 598d747

Browse files
authored
feat: create docs site (#1)
1 parent 4de898e commit 598d747

38 files changed

+8686
-0
lines changed

src/docs_site/.eslintrc.js

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
/**
2+
* @type {import('@types/eslint').Linter.BaseConfig}
3+
*/
4+
module.exports = {
5+
extends: ['plugin:@docusaurus/recommended'],
6+
plugins: ['@docusaurus'],
7+
parserOptions: {
8+
ecmaVersion: 'latest',
9+
sourceType: 'module',
10+
},
11+
parser: '@babel/eslint-parser',
12+
};
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
name: Bug Report
3+
about: Create a report to help us improve
4+
title: 'fix: '
5+
labels: bug
6+
---
7+
8+
**Description**
9+
10+
A clear and concise description of what the bug is.
11+
12+
**Steps To Reproduce**
13+
14+
1. Go to '...'
15+
2. Click on '....'
16+
3. Scroll down to '....'
17+
4. See error
18+
19+
**Expected Behavior**
20+
21+
A clear and concise description of what you expected to happen.
22+
23+
**Screenshots**
24+
25+
If applicable, add screenshots to help explain your problem.
26+
27+
**Additional Context**
28+
29+
Add any other context about the problem here.
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
name: Build System
3+
about: Changes that affect the build system or external dependencies
4+
title: 'build: '
5+
labels: build
6+
---
7+
8+
**Description**
9+
10+
Describe what changes need to be done to the build system and why.
11+
12+
**Requirements**
13+
14+
- [ ] The build system is passing
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
name: Chore
3+
about: Other changes that don't modify src or test files
4+
title: 'chore: '
5+
labels: chore
6+
---
7+
8+
**Description**
9+
10+
Clearly describe what change is needed and why. If this changes code then please use another issue type.
11+
12+
**Requirements**
13+
14+
- [ ] No functional changes to the code
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
name: Continuous Integration
3+
about: Changes to the CI configuration files and scripts
4+
title: 'ci: '
5+
labels: ci
6+
---
7+
8+
**Description**
9+
10+
Describe what changes need to be done to the ci/cd system and why.
11+
12+
**Requirements**
13+
14+
- [ ] The ci system is passing
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
blank_issues_enabled: false
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
name: Documentation
3+
about: Improve the documentation so all collaborators have a common understanding
4+
title: 'docs: '
5+
labels: documentation
6+
---
7+
8+
**Description**
9+
10+
Clearly describe what documentation you are looking to add or improve.
11+
12+
**Requirements**
13+
14+
- [ ] Requirements go here
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
name: Feature Request
3+
about: A new feature to be added to the project
4+
title: 'feat: '
5+
labels: feature
6+
---
7+
8+
**Description**
9+
10+
Clearly describe what you are looking to add. The more context the better.
11+
12+
**Requirements**
13+
14+
- [ ] Checklist of requirements to be fulfilled
15+
16+
**Additional Context**
17+
18+
Add any other context or screenshots about the feature request go here.
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
name: Performance Update
3+
about: A code change that improves performance
4+
title: 'perf: '
5+
labels: performance
6+
---
7+
8+
**Description**
9+
10+
Clearly describe what code needs to be changed and what the performance impact is going to be. Bonus point's if you can tie this directly to user experience.
11+
12+
**Requirements**
13+
14+
- [ ] There is no drop in test coverage.
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
name: Refactor
3+
about: A code change that neither fixes a bug nor adds a feature
4+
title: 'refactor: '
5+
labels: refactor
6+
---
7+
8+
**Description**
9+
10+
Clearly describe what needs to be refactored and why. Please provide links to related issues (bugs or upcoming features) in order to help prioritize.
11+
12+
**Requirements**
13+
14+
- [ ] There is no drop in test coverage.

0 commit comments

Comments
 (0)