Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
82 changes: 82 additions & 0 deletions .github/ISSUE_TEMPLATE/content-issue.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
name: 📝 Content Issue
description: Report problems with existing documentation content (typos, errors, confusing sections, outdated information)
title: '[Content Issue]: '
labels: ['content', 'bug']
body:
- type: markdown
attributes:
value: |
Thanks for helping us improve our documentation! Use this template to report issues with existing content such as typos, errors, confusing sections, or outdated information.

For platform/site functionality issues, please use the "Platform Bug" template instead.

- type: dropdown
id: issue-type
attributes:
label: Issue Type
description: What kind of content issue is this?
options:
- Incorrect information
- Missing information
- Confusing/unclear content
- Typo or formatting error
- Outdated information
- Other
validations:
required: true

- type: input
id: content-location
attributes:
label: Content Location
description: URL or section where the issue is located. Make sure to include the version number too.
placeholder: "https://docs.harperdb.io/docs/getting-started/#harper-basics or '(4.6) Getting Started > Harper Basics'"
validations:
required: true

- type: textarea
id: issue-description
attributes:
label: What's wrong?
description: Describe the issue with the current content
placeholder: "Be as specific as possible about what's incorrect, missing, or confusing"
validations:
required: true

- type: textarea
id: suggested-improvement
attributes:
label: Suggested improvement
description: How would you improve this content? (optional)
placeholder: 'What would make this clearer or more accurate?'

- type: textarea
id: additional-context
attributes:
label: Additional context
description: Any other context that might be helpful
placeholder: 'Screenshots, related issues, etc.'

- type: dropdown
id: contribution-intent
attributes:
label: Are you planning to fix this issue?
description: Let us know if you'd like to contribute the fix!
options:
- "Yes, I'll submit a PR to fix this"
- "Yes, but I'm a first-time contributor and could use guidance"
- 'Maybe, depending on complexity'
- 'No, just reporting the issue'
validations:
required: true

- type: checkboxes
id: first-time-contributor
attributes:
label: First-time contributor support
description: Check any that apply (only if you're planning to contribute)
options:
- label: I'm new to contributing and would appreciate guidance on the process
- label: I'd like help understanding the project structure
- label: I need assistance with setting up the development environment
- label: I'm comfortable contributing but new to this project specifically
93 changes: 93 additions & 0 deletions .github/ISSUE_TEMPLATE/content-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
name: 📚 Content Request
description: Request new documentation or coverage for undocumented features, APIs, or functionality
title: '[Content Request]: '
labels: ['content', 'enhancement']
body:
- type: markdown
attributes:
value: |
Thanks for helping us identify documentation gaps! Use this template to request new documentation for undocumented features, missing API coverage, or other content needs.

For platform/site feature requests, please use the "Platform Feature Request" template instead.

- type: dropdown
id: request-type
attributes:
label: Request Type
description: What kind of documentation is needed?
options:
- Undocumented existing feature
- New feature documentation
- API/method documentation
- Tutorial or guide
- Code examples
- Missing section coverage
- Other
validations:
required: true

- type: textarea
id: what-needs-documenting
attributes:
label: What needs to be documented?
description: Describe what functionality, feature, or topic needs documentation
placeholder: "Be specific about what's missing or undocumented"
validations:
required: true

- type: textarea
id: suggested-location
attributes:
label: Where should this be documented?
description: Suggest where in the docs this content should live
placeholder: 'New section, existing page URL, or general area'

- type: textarea
id: use-case
attributes:
label: Why is this needed?
description: What use case or problem would this documentation solve?
placeholder: 'How would this help users? What are people trying to accomplish?'

- type: textarea
id: existing-information
attributes:
label: Existing information
description: Do you have any information, examples, or resources that could help?
placeholder: 'Code snippets, API responses, screenshots, links to related features, etc.'

- type: dropdown
id: priority
attributes:
label: Priority/Impact
description: How important is this documentation gap?
options:
- 'High - critical for user success'
- 'Medium - important but not urgent'
- 'Low - nice to have'
validations:
required: true

- type: dropdown
id: contribution-intent
attributes:
label: Are you planning to fix this issue?
description: Let us know if you'd like to contribute the fix!
options:
- "Yes, I'll submit a PR to fix this"
- "Yes, but I'm a first-time contributor and could use guidance"
- 'Maybe, depending on complexity'
- 'No, just reporting the issue'
validations:
required: true

- type: checkboxes
id: first-time-contributor
attributes:
label: First-time contributor support
description: Check any that apply (only if you're planning to contribute)
options:
- label: I'm new to contributing and would appreciate guidance on the process
- label: I'd like help understanding the project structure
- label: I need assistance with setting up the development environment
- label: I'm comfortable contributing but new to this project specifically
24 changes: 0 additions & 24 deletions .github/ISSUE_TEMPLATE/documentation-content-error.md

This file was deleted.

125 changes: 125 additions & 0 deletions .github/ISSUE_TEMPLATE/platform-bug.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,125 @@
name: 🐛 Platform Bug
description: Report issues with the documentation site's functionality (broken features, UI problems, performance issues)
title: '[Platform Bug]: '
labels: ['platform', 'bug']
body:
- type: markdown
attributes:
value: |
Thanks for reporting a platform issue! Use this template for problems with the site's functionality such as broken search, navigation issues, mobile problems, or performance issues.

For content-related issues (typos, errors, confusing text), please use the "Content Issue" template instead.

- type: input
id: bug-summary
attributes:
label: Bug Summary
description: Brief summary of the issue
placeholder: "Search doesn't work on mobile, navigation menu broken, etc."
validations:
required: true

- type: textarea
id: steps-to-reproduce
attributes:
label: Steps to Reproduce
description: How can we reproduce this issue?
placeholder: |
1. Go to '...'
2. Click on '...'
3. Scroll down to '...'
4. See error
validations:
required: true

- type: textarea
id: expected-behavior
attributes:
label: Expected Behavior
description: What should happen?
placeholder: 'What did you expect to happen?'
validations:
required: true

- type: textarea
id: actual-behavior
attributes:
label: Actual Behavior
description: What actually happened?
placeholder: 'What actually happened instead?'
validations:
required: true

- type: input
id: url
attributes:
label: Page URL
description: Where did this issue occur?
placeholder: 'https://docs.example.com/page'

- type: dropdown
id: browsers
attributes:
label: Browser
description: Which browser are you using?
multiple: true
options:
- Chrome
- Firefox
- Safari
- Edge
- Mobile Safari (iOS)
- Chrome Mobile (Android)
- Other

- type: input
id: device
attributes:
label: Device/OS
description: What device and operating system?
placeholder: 'Windows 11, macOS 14, iPhone 15, etc.'

- type: textarea
id: console-errors
attributes:
label: Console Errors
description: Any console errors or network issues? (Check browser dev tools)
placeholder: 'Copy/paste any error messages from the browser console'

- type: textarea
id: screenshots
attributes:
label: Screenshots or Videos
description: Add screenshots or videos to help explain the problem
placeholder: 'Drag and drop images here or paste URLs'

- type: textarea
id: additional-context
attributes:
label: Additional Context
description: Any other relevant information
placeholder: 'Frequency of issue, workarounds, related issues, etc.'

- type: dropdown
id: contribution-intent
attributes:
label: Are you planning to fix this issue?
description: Let us know if you'd like to contribute the fix!
options:
- "Yes, I'll submit a PR to fix this"
- "Yes, but I'm a first-time contributor and could use guidance"
- 'Maybe, depending on complexity'
- 'No, just reporting the issue'
validations:
required: true

- type: checkboxes
id: first-time-contributor
attributes:
label: First-time contributor support
description: Check any that apply (only if you're planning to contribute)
options:
- label: I'm new to contributing and would appreciate guidance on the process
- label: I'd like help understanding the project structure
- label: I need assistance with setting up the development environment
- label: I'm comfortable contributing but new to this project specifically
Loading