Skip to content

[BOUNTY] Troubleshooting guide + contributor onboarding + release notes generator#454

Open
saimbcn1-lang wants to merge 1 commit into
imDarshanGK:mainfrom
saimbcn1-lang:bounty-docs
Open

[BOUNTY] Troubleshooting guide + contributor onboarding + release notes generator#454
saimbcn1-lang wants to merge 1 commit into
imDarshanGK:mainfrom
saimbcn1-lang:bounty-docs

Conversation

@saimbcn1-lang

Copy link
Copy Markdown

Changes

docs/troubleshooting.md

  • 12 common setup errors with diagnostic commands
  • Covers: Ollama, Python env, CUDA, CORS, port conflicts, document uploads
  • Quick diagnostic script at top
  • Links to Discord and issue tracker

docs/contributor-onboarding.md

  • Architecture diagram showing React→FastAPI→Ollama pipeline
  • Directory structure reference table
  • Local dev setup (backend + frontend + Ollama)
  • PR checklist with conventional commit convention
  • Testing guide (pytest, vitest, coverage)
  • Common dev tasks (new format, new model, dependency updates)
  • Release process steps

scripts/generate-release-notes.py

  • Auto-generates markdown release notes from merged PRs
  • Groups by category (feat, fix, docs, etc.) using conventional commits
  • Lists all contributors with @mentions
  • Supports --latest N, --tag, --version, --output flags
  • Works with GitHub CLI (gh)

Closes #321, closes #320, closes #313

…notes generator

- docs/troubleshooting.md: 12 common setup errors with diagnostic commands and fixes
- docs/contributor-onboarding.md: architecture overview, dev setup, PR checklist, testing guide
- scripts/generate-release-notes.py: auto-generate release notes from merged PRs by category

Closes imDarshanGK#321, closes imDarshanGK#320, closes imDarshanGK#313
@vercel

vercel Bot commented Jun 24, 2026

Copy link
Copy Markdown

@saimbcn1-lang is attempting to deploy a commit to the Darshan's projects Team on Vercel.

A member of the Team first needs to authorize it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

1 participant