Skip to content

README.md

Latest commit

 

History

History
98 lines (79 loc) · 6.61 KB

README.md

File metadata and controls

98 lines (79 loc) · 6.61 KB
Raw

gadak Documentation

Start here

A route, not a contributor reading list. Each line is the question that document answers.

  • README.md: what is gadak, and how do I try it?
  • INSTALL.md: how do I install the CLI or the app?
  • DESKTOP.md: when do I want the desktop window instead of gadak serve?
  • AGENT_SETUP.md: how do I give a coding agent access (one paste per tool)?
  • MCP.md: how do I wire MCP on a host that has no shell?
  • FAQ.md: what should I ask before pointing this at a company Jira?
  • BENCHMARKS.md: how does the local mirror compare to the live REST API?

Before you depend on it

  • PROMISES.md: nine claims, each with one command you can run in a clone to check it
  • MAINTENANCE.md: how this project is run — response times, what gets merged, what happens if it stops
  • ../SECURITY.md: the threat model, every outbound destination, and how to report a hole

Using gadak

  • MIRROR.md: SQL, CLI, REST, and MCP against the local mirror — the cookbook
  • AGENT_ACCESS.md: which access layer to reach for, and what each costs
  • DASHBOARDS.md: agent-authored dashboards — the frame contract, datasources, vendored charts, and the two residual leak channels
  • RECIPES.md: questions JQL cannot ask, as ready-to-run SQL
  • CONFIGURATION.md: config.json keys, defaults, floors
  • NETWORK.md: what gadak does with the network — mirror reads stay local; writes go to the origin you configured
  • WINDOWS-SIGNING.md: Windows showed a warning — which file you have, and why releases are unsigned
  • EXTENDING.md: config, enrichments, and SQL extension axes
  • PLUGINS.md: enrichment contract and payload shapes
  • PAIN_POINTS.md: sourced Jira complaints, and what gadak does about each

Developing gadak

If you are changing this repository, not if you are using it. Everything under project/ is that half — it is there so a reader looking for how to use gadak never has to step over a session handoff or a recording rig.

  • STATE_OF_PLAY.md: what actually exists right now, the next task, and hard-won Jira behaviors
  • ROADMAP.md: ordering and reasoning
  • ARCHITECTURE.md: components, module boundaries, data flow
  • CONCEPT.md: the idea, the two surfaces, and good-fit / bad-fit
  • EXTRACTION.md: where this code came from, what was cut at extraction time
  • DERIVE.md: columns gadak computes at sync (reopens, resolution dates, priority rank, epic keys) — not source fields
  • UX_PRINCIPLES.md: the standard every UI wave is measured against
  • GOOD_FIRST_ISSUES.md: concrete starter work with code evidence
  • MEDIA.md: regenerating demo GIFs/MP4
  • ../AGENTS.md: contributor contract — required reading order, SQL/CLI/REST/MCP pointers

Specs and contracts

Runbooks

Decisions

Two files on disk share the number 0007 (0007-jql-subset.md and 0007-rename-to-gadak.md). The filenames are left as they are — renumbering a decision file is a revision, and decisions are addendum-only. This index lists every file.

Research