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
72 changes: 72 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
---
name: ✨ Documentation Feature Request
about: Suggest improvements for GaiaNet documentation
title: "[DOCS-FEATURE] "
labels: enhancement, documentation
assignees: ""
---

### What documentation improvement are you requesting?

<!--
  What should we add or change in our docs? Examples:
  - New guide/tutorial about [specific topic]
  - Improvement to existing [page name]
  - Better examples for [feature]
  - Enhanced [diagrams/visuals] for [concept]
-->

### Location of Suggested Change

<!-- Where should this appear? (Check all that apply) -->

- [ ] New page (suggest title: \_\_\_\_)
- [ ] Existing page: [URL or file path]
- [ ] Navigation/sidebar
- [ ] Search functionality
- [ ] Code examples
- [ ] API reference
- [ ] Tutorials/guides
- [ ] Diagrams/visualizations
- [ ] Other:

### Which GaiaNet component does this affect?

<!-- Check all that apply -->

- [ ] General documentation
- [ ] Node operator docs
- [ ] Developer docs
- [ ] API documentation
- [ ] CLI reference
- [ ] Tutorials
- [ ] Architecture overviews

### Why is this needed?

<!--
  How would this help users? Examples:
  - "It would help node operators configure X properly"
  - "Developers struggle to understand Y concept"
  - "This is missing from our current onboarding"
-->

### Proposed Content

<!--
  Suggest specific content:
  - For new pages: Outline structure (H2/H3 headings)
  - For changes: Provide sample text
  - For examples: Show code snippet
  - For visuals: Describe diagram elements
-->

### Additional Context

<!--
  Any supporting information:
  - Related GitHub issues/PRs (#__)
  - Priority suggestion (Low/Medium/High/Critical)
  - Screenshots/mockups (drag & drop here)
  - Target user persona (node operator/developer/new user)
-->
53 changes: 53 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
---
name: Documentation Pull Request
about: Describe the changes in this documentation PR
title: "[DOCS] "
labels: documentation
---

## Type of Change

<!-- Check the type of change you're submitting: -->

- [ ] New documentation page
- [ ] Update to existing page
- [ ] Fix (typo, broken link, etc.)
- [ ] Content restructuring/organization
- [ ] Other (please describe):

## Related Issue

<!-- If this PR resolves an open issue, please link it here. Use the full URL or the issue number. -->

Fixes: #issue_number
Related to: #issue_number

## Description of Changes

<!--
  Explain the changes you've made.
  Include details about what was changed and why.
  If this PR introduces a new page, describe its purpose.
-->

## Screenshots (if applicable)

<!--
  If your changes affect the visual layout or appearance,
  include before-and-after screenshots.
-->

## Checklist

<!-- Verify the following before submitting your PR: -->

- [ ] I have reviewed the [Contributing Guidelines](https://github.com/GaiaNet-AI/docs/blob/main/CONTRIBUTING.md) (if available).
- [ ] My changes are focused on a single documentation topic.
- [ ] I have checked for spelling and grammar errors.
- [ ] I have previewed the changes locally to ensure they render correctly.
- [ ] I have included any necessary updates to the sidebar or navigation.
- [ ] I have also read the [Code Of Conduct](https://github.com/GaiaNet-AI/docs/blob/main/CODE_OF_CONDUCT.md)

## Additional Notes

<!-- Any additional information for reviewers? -->