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
69 changes: 69 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
---
name: "Bug Report"
about: "Report an issue in the OrbitStream Documentation"
title: "[BUG] "
labels: ["bug", "documentation", "needs-triage"]
assignees: ""
---

# Documentation Bug Report

Check failure on line 9 in .github/ISSUE_TEMPLATE/bug_report.md

View workflow job for this annotation

GitHub Actions / lint-markdown

Multiple top-level headings in the same document

.github/ISSUE_TEMPLATE/bug_report.md:9 MD025/single-title/single-h1 Multiple top-level headings in the same document [Context: "Documentation Bug Report"] https://github.com/DavidAnson/markdownlint/blob/v0.37.4/doc/md025.md

## 📝 Description

<!-- A clear and concise description of the documentation issue. -->

## 📄 Affected Document

<!-- Which document has the issue? -->

- **File**: [e.g., `architecture/backend.md`, `api/openapi.yaml`, `contract/spec.md`]
- **Section**: [e.g., "Database Schema", "API Endpoints"]
- **Line(s)**: [e.g., line 42-50]

## 🔄 What's Wrong

<!-- Is the information incorrect, outdated, incomplete, or unclear? -->

- [ ] Incorrect information
- [ ] Outdated information
- [ ] Missing information
- [ ] Unclear / confusing wording
- [ ] Broken link
- [ ] Code example doesn't work
- [ ] Other: ___

## ✅ Expected Content

<!-- What should the documentation say? -->

## ❌ Actual Content

<!-- What does the documentation currently say? Paste the problematic text. -->

## 🔍 Evidence

<!-- If the docs don't match the implementation, paste evidence. -->

**Documentation says:**
```

Check failure on line 48 in .github/ISSUE_TEMPLATE/bug_report.md

View workflow job for this annotation

GitHub Actions / lint-markdown

Fenced code blocks should have a language specified

.github/ISSUE_TEMPLATE/bug_report.md:48 MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"] https://github.com/DavidAnson/markdownlint/blob/v0.37.4/doc/md040.md

Check failure on line 48 in .github/ISSUE_TEMPLATE/bug_report.md

View workflow job for this annotation

GitHub Actions / lint-markdown

Fenced code blocks should be surrounded by blank lines

.github/ISSUE_TEMPLATE/bug_report.md:48 MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```"] https://github.com/DavidAnson/markdownlint/blob/v0.37.4/doc/md031.md
[Paste doc content]
```

**Actual implementation:**
```typescript

Check failure on line 53 in .github/ISSUE_TEMPLATE/bug_report.md

View workflow job for this annotation

GitHub Actions / lint-markdown

Fenced code blocks should be surrounded by blank lines

.github/ISSUE_TEMPLATE/bug_report.md:53 MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```typescript"] https://github.com/DavidAnson/markdownlint/blob/v0.37.4/doc/md031.md
// Paste actual code that contradicts the docs
```

## 💡 Suggested Fix

<!-- If you know how to fix it, describe the change. -->

## 📎 Additional Context

<!-- Any other context, links to related docs, or references. -->

## ✅ Checklist

- [ ] I have searched existing issues and this is not a duplicate
- [ ] I have identified the specific document and section
- [ ] I have described what's wrong and what it should say
8 changes: 8 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
blank_issues_enabled: false
contact_links:
- name: Documentation
url: https://github.com/your-org/OrbitStream/blob/main/orbitstream_docs/README.md
about: Read the OrbitStream documentation before opening an issue
- name: Security Vulnerability
url: https://github.com/your-org/OrbitStream/security/advisories/new
about: Report security vulnerabilities privately
77 changes: 77 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
---
name: "Documentation Request"
about: "Suggest new or improved documentation for OrbitStream"
title: "[DOCS] "
labels: ["documentation", "enhancement", "needs-triage"]
assignees: ""
---

# Documentation Request

Check failure on line 9 in .github/ISSUE_TEMPLATE/feature_request.md

View workflow job for this annotation

GitHub Actions / lint-markdown

Multiple top-level headings in the same document

.github/ISSUE_TEMPLATE/feature_request.md:9 MD025/single-title/single-h1 Multiple top-level headings in the same document [Context: "Documentation Request"] https://github.com/DavidAnson/markdownlint/blob/v0.37.4/doc/md025.md

## 📝 Summary

<!-- A clear, one-sentence summary of the documentation you want. -->

## 🎯 Problem Statement

<!-- What information is missing or unclear? Who needs this documentation? -->

## 💡 Proposed Content

<!-- Describe what the documentation should cover. -->

### Document Location

- [ ] `architecture/overview.md` — System architecture
- [ ] `architecture/backend.md` — Backend design
- [ ] `architecture/frontend.md` — Frontend design
- [ ] `architecture/contract.md` — Contract architecture
- [ ] `architecture/stellar-features.md` — Stellar-specific features
- [ ] `api/openapi.yaml` — API specification
- [ ] `contract/spec.md` — Contract specification
- [ ] `contract/events.md` — Contract events
- [ ] `guides/integration-guide.md` — SDK integration
- [ ] `guides/merchant-setup.md` — Merchant setup
- [ ] `security/threat-model.md` — Security considerations
- [ ] New document: ___

### Content Type

- [ ] New documentation (doesn't exist yet)
- [ ] Update existing documentation (outdated or incomplete)
- [ ] Code examples (need working examples for a feature)
- [ ] Tutorial / walkthrough (step-by-step guide)
- [ ] API reference (endpoint documentation)
- [ ] Architecture decision record (ADR)

## 📋 Acceptance Criteria

- [ ] Criterion 1
- [ ] Criterion 2
- [ ] Criterion 3

## 🏗️ Implementation Notes

<!-- Any technical details, references to specs, or links to source code. -->

### Related Source Code

<!-- Link to the source code that the documentation should describe. -->

- `OrbitStream_backend/src/...` —

Check failure on line 61 in .github/ISSUE_TEMPLATE/feature_request.md

View workflow job for this annotation

GitHub Actions / lint-markdown

Trailing spaces

.github/ISSUE_TEMPLATE/feature_request.md:61:34 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1] https://github.com/DavidAnson/markdownlint/blob/v0.37.4/doc/md009.md
- `orbitstream_contracts/src/...` —

Check failure on line 62 in .github/ISSUE_TEMPLATE/feature_request.md

View workflow job for this annotation

GitHub Actions / lint-markdown

Trailing spaces

.github/ISSUE_TEMPLATE/feature_request.md:62:36 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1] https://github.com/DavidAnson/markdownlint/blob/v0.37.4/doc/md009.md
- `OrbitStream-Checkout-sdk/src/...` —

Check failure on line 63 in .github/ISSUE_TEMPLATE/feature_request.md

View workflow job for this annotation

GitHub Actions / lint-markdown

Trailing spaces

.github/ISSUE_TEMPLATE/feature_request.md:63:39 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1] https://github.com/DavidAnson/markdownlint/blob/v0.37.4/doc/md009.md

### References

<!-- Links to external specs, articles, or similar documentation. -->

## 📎 Additional Context

<!-- Any other context, mockups, or examples. -->

## ✅ Checklist

- [ ] I have searched existing docs and this is not a duplicate
- [ ] I have identified where the documentation should go
- [ ] I have described what content is needed
Loading