Add issue templates, GitHub stars badge, fix health endpoint type hint
This commit is contained in:
parent
09145206d2
commit
05ed49b893
4 changed files with 127 additions and 1 deletions
68
.github/ISSUE_TEMPLATE/bug.yml
vendored
Normal file
68
.github/ISSUE_TEMPLATE/bug.yml
vendored
Normal file
|
|
@ -0,0 +1,68 @@
|
||||||
|
name: Bug report
|
||||||
|
description: Report a bug or unexpected behavior
|
||||||
|
labels: ["bug"]
|
||||||
|
body:
|
||||||
|
- type: markdown
|
||||||
|
attributes:
|
||||||
|
value: |
|
||||||
|
Thanks for reporting a bug!
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
id: description
|
||||||
|
attributes:
|
||||||
|
label: Description
|
||||||
|
description: What happened?
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
id: expected-behavior
|
||||||
|
attributes:
|
||||||
|
label: Expected behavior
|
||||||
|
description: What should have happened instead?
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
id: steps-to-reproduce
|
||||||
|
attributes:
|
||||||
|
label: Steps to reproduce
|
||||||
|
description: How can we reproduce the issue?
|
||||||
|
placeholder: |
|
||||||
|
1. Go to ...
|
||||||
|
2. Click on ...
|
||||||
|
3. See error
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: dropdown
|
||||||
|
id: scope
|
||||||
|
attributes:
|
||||||
|
label: Scope
|
||||||
|
options:
|
||||||
|
- Frontend
|
||||||
|
- Backend
|
||||||
|
- Infra / CI
|
||||||
|
- Full-stack
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: dropdown
|
||||||
|
id: severity
|
||||||
|
attributes:
|
||||||
|
label: Severity
|
||||||
|
options:
|
||||||
|
- Critical (app crash / data loss)
|
||||||
|
- Major (feature broken)
|
||||||
|
- Minor (cosmetic / workaround exists)
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
id: environment
|
||||||
|
attributes:
|
||||||
|
label: Environment
|
||||||
|
description: Browser, OS, deployment mode (Docker remote/local, dev), version
|
||||||
|
placeholder: "Chrome 124, macOS, Docker remote, v0.3.0"
|
||||||
|
validations:
|
||||||
|
required: false
|
||||||
48
.github/ISSUE_TEMPLATE/feature.yml
vendored
Normal file
48
.github/ISSUE_TEMPLATE/feature.yml
vendored
Normal file
|
|
@ -0,0 +1,48 @@
|
||||||
|
name: Feature request
|
||||||
|
description: Suggest a new feature or enhancement
|
||||||
|
labels: ["enhancement"]
|
||||||
|
body:
|
||||||
|
- type: markdown
|
||||||
|
attributes:
|
||||||
|
value: |
|
||||||
|
Thanks for taking the time to suggest a feature!
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
id: description
|
||||||
|
attributes:
|
||||||
|
label: Description
|
||||||
|
description: What do you want and why?
|
||||||
|
placeholder: As a user, I want to ... so that ...
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
id: acceptance-criteria
|
||||||
|
attributes:
|
||||||
|
label: Acceptance criteria
|
||||||
|
description: How do we know this is done?
|
||||||
|
placeholder: |
|
||||||
|
- [ ] ...
|
||||||
|
- [ ] ...
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
id: technical-notes
|
||||||
|
attributes:
|
||||||
|
label: Technical notes
|
||||||
|
description: Implementation hints, related files, architecture considerations (optional)
|
||||||
|
validations:
|
||||||
|
required: false
|
||||||
|
|
||||||
|
- type: dropdown
|
||||||
|
id: scope
|
||||||
|
attributes:
|
||||||
|
label: Scope
|
||||||
|
options:
|
||||||
|
- Frontend
|
||||||
|
- Backend
|
||||||
|
- Infra / CI
|
||||||
|
- Full-stack
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
10
README.md
10
README.md
|
|
@ -1,3 +1,13 @@
|
||||||
|
---
|
||||||
|
title: Docling Studio
|
||||||
|
emoji: 📄
|
||||||
|
colorFrom: yellow
|
||||||
|
colorTo: blue
|
||||||
|
sdk: docker
|
||||||
|
app_port: 3000
|
||||||
|
pinned: false
|
||||||
|
---
|
||||||
|
|
||||||
# Docling Studio
|
# Docling Studio
|
||||||
|
|
||||||

|

|
||||||
|
|
|
||||||
|
|
@ -102,7 +102,7 @@ app.include_router(analyses_router)
|
||||||
|
|
||||||
|
|
||||||
@app.get("/api/health")
|
@app.get("/api/health")
|
||||||
async def health() -> dict[str, str]:
|
async def health() -> dict[str, str | int]:
|
||||||
"""Health check endpoint — verifies database connectivity."""
|
"""Health check endpoint — verifies database connectivity."""
|
||||||
db_status = "ok"
|
db_status = "ok"
|
||||||
try:
|
try:
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue