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
21 changes: 21 additions & 0 deletions CHANGELOG.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
= Changelog
:toc:

Timeline of Issues Browser functional changes. Detail pages live under `changelog-details/`.

== 2026-08-08 — Index cache + opt-in full backup

* Lightweight central index cache with opt-in full per-repo backup archives.
* Monitor/daemon path for continuous sync (`issuesd` + tray).
* See link:changelog-details/2026-08-08%20-%20index-cache-and-backup.adoc[Detailed changelog].

== 2026-08-08 — Qt tray via dqt fork; repo-get forge profiles

* Tray uses dqt git fork for `QSystemTrayIcon`; forge profiles via repo-get DUB package.
* See link:changelog-details/2026-08-08%20-%20qt-tray-and-forge-profiles.adoc[Detailed changelog].

== 2026-08 — Rename to Issues Browser + docs hub

* Renamed from issue-tracker to issues-browser; Antora component wired to `https://docs.devcentr.org/issues-browser/`.
* Stopped secondary GitHub Pages Antora publish (validation-only docs CI).
* See link:changelog-details/2026-08%20-%20rename-and-docs-hub.adoc[Detailed changelog].
125 changes: 117 additions & 8 deletions README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,38 +3,147 @@ ifndef::env-github[:icons: font]
:toclevels: 2
:sectanchors:

ifdef::env-github[]
++++
<a id="readme-top"></a>
<div align="center">
<a href="https://github.com/dev-centr/issues-browser/graphs/contributors"><img src="https://img.shields.io/github/contributors/dev-centr/issues-browser.svg?style=for-the-badge" alt="Contributors"></a>
<a href="https://github.com/dev-centr/issues-browser/network/members"><img src="https://img.shields.io/github/forks/dev-centr/issues-browser.svg?style=for-the-badge" alt="Forks"></a>
<a href="https://github.com/dev-centr/issues-browser/stargazers"><img src="https://img.shields.io/github/stars/dev-centr/issues-browser.svg?style=for-the-badge" alt="Stargazers"></a>
<a href="https://github.com/dev-centr/issues-browser/issues"><img src="https://img.shields.io/github/issues/dev-centr/issues-browser.svg?style=for-the-badge" alt="Issues"></a>
<br />
<h3 align="center">Issues Browser</h3>
<p align="center">
Local forge metadata index (default) and opt-in per-repo backup for issues, pull requests, and discussions. Browse offline via GUI/CLI; monitor with <code>issuesd</code> + tray.<br />
<a href="https://docs.devcentr.org/issues-browser/"><strong>Explore the docs »</strong></a><br /><br />
<a href="https://github.com/dev-centr/issues-browser/issues">Report Bug</a>
&middot;
<a href="https://github.com/dev-centr/issues-browser/issues">Request Feature</a>
</p>
</div>
++++
endif::[]

ifndef::env-github[]
image:https://img.shields.io/github/contributors/dev-centr/issues-browser.svg?style=for-the-badge[Contributors,link=https://github.com/dev-centr/issues-browser/graphs/contributors]
image:https://img.shields.io/github/forks/dev-centr/issues-browser.svg?style=for-the-badge[Forks,link=https://github.com/dev-centr/issues-browser/network/members]
image:https://img.shields.io/github/stars/dev-centr/issues-browser.svg?style=for-the-badge[Stars,link=https://github.com/dev-centr/issues-browser/stargazers]
image:https://img.shields.io/github/issues/dev-centr/issues-browser.svg?style=for-the-badge[Issues,link=https://github.com/dev-centr/issues-browser/issues]

= Issues Browser

Local **forge metadata index** (default) and **opt-in per-repo backup** for issues, pull requests, and discussions. Browse offline via GUI/CLI; monitor continuously with `issuesd` + tray.
Local forge metadata index (default) and opt-in per-repo backup for issues, pull requests, and discussions. Browse offline via GUI/CLI; monitor with `issuesd` + tray.

Works with https://github.com/dev-centr/repo-drive[RepoDrive] (`POST /open-repo`, index/backup fallbacks).
link:https://docs.devcentr.org/issues-browser/[Explore the docs] ·
link:https://github.com/dev-centr/issues-browser/issues[Report Bug] ·
link:https://github.com/dev-centr/issues-browser/issues[Request Feature]
endif::[]

== About The Project

link:https://docs.devcentr.org/issues-browser/[Docs] ·
link:https://github.com/dev-centr/issues-browser/issues[Issues]
Works with https://github.com/dev-centr/repo-drive[RepoDrive] (`POST /open-repo`, index/backup fallbacks).

== Components
=== Components

* **Library** — index + backup sync, SDL forge profiles, SQLite schema, monitor store
* **CLI** (`issues-browser`) — ProHelp + sync/list/monitor (`--backup` / `--index-only`)
* **GUI** (`issues-browser-gui`) — DlangUI browser with Cached vs Backed up
* **Daemon** (`issuesd`) — polling + localhost IPC `:17365` (`/open-repo`, `/monitor/set-backup`)
* **Tray** (`issues-browser-tray`) — Win32 tray client for the daemon

== Quick start
Index: `$CODE_ROOT/github.com/AMDphreak/.issues/index/index.sqlite` +
archives for backup-enabled repos under `archives/<host>/<owner>/<repo>/database.sqlite`.

Depth lives in the docs hub (not a secondary Pages site).

ifdef::env-github[]
++++
<p align="right">(<a href="#readme-top">back to top</a>)</p>
++++
endif::[]

== Built With

* Language
** link:https://dlang.org/[image:https://img.shields.io/badge/D-B03931?style=for-the-badge&logo=d&logoColor=white[D]]
* UI
** DlangUI (GUI); Win32 tray
* Docs
** link:https://antora.org[image:https://img.shields.io/badge/Antora-4A4A55?style=for-the-badge&logo=asciidoctor&logoColor=white[Antora]]

ifdef::env-github[]
++++
<p align="right">(<a href="#readme-top">back to top</a>)</p>
++++
endif::[]

== Getting Started

=== Prerequisites

* link:https://dub.pm/[DUB] and a D compiler (LDC or DMD)
* **gh** CLI authenticated for GitHub API / GraphQL access (for sync)
* **SQLite**: bundled d2sqlite3 `all-included` config (default) or provide `sqlite3.lib` on Windows

=== Build

[source,bash]
----
dub build --config=cli
dub build --config=application # GUI (requires dlangui)
dub build --config=daemon
dub build --config=library
----

=== Quick start

[source,bash]
----
issues-browser --sync ./myrepo
issues-browser --sync ./myrepo --backup --yes
issues-browser --set-backup owner/name
issues-browser --monitor-add owner/name
dub build --config=daemon && issuesd
----

Index: `$CODE_ROOT/github.com/AMDphreak/.issues/index/index.sqlite` +
archives for backup-enabled repos under `archives/<host>/<owner>/<repo>/database.sqlite`.
Full docs: https://docs.devcentr.org/issues-browser/

ifdef::env-github[]
++++
<p align="right">(<a href="#readme-top">back to top</a>)</p>
++++
endif::[]

== Changelog

link:CHANGELOG.adoc[Changelog]

ifdef::env-github[]
++++
<p align="right">(<a href="#readme-top">back to top</a>)</p>
++++
endif::[]

== License

MIT (application). ProHelp dependency is PCDL 1.0 — see https://github.com/openshellorg/prohelp

ifdef::env-github[]
++++
<p align="right">(<a href="#readme-top">back to top</a>)</p>
++++
endif::[]

== Contact

Dev-Centr — link:https://github.com/dev-centr[github.com/dev-centr]

* Project: https://github.com/dev-centr/issues-browser
* Docs: https://docs.devcentr.org/issues-browser/
* Site: https://devcentr.org

ifdef::env-github[]
++++
<p align="right">(<a href="#readme-top">back to top</a>)</p>
++++
endif::[]
12 changes: 12 additions & 0 deletions changelog-details/2026-08 - rename-and-docs-hub.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
= 2026-08 — Rename and docs hub

== Summary

Project renamed from issue-tracker to issues-browser. Documentation publishes through the Dev-Centr Antora hub rather than a secondary GitHub Pages site.

== Details

* Module/CLI/GUI rename to `issuesbrowser` / Issues Browser.
* Hub playbook sources: `https://github.com/dev-centr/issues-browser.git`.
* Homepage and README docs CTA: `https://docs.devcentr.org/issues-browser/`.
* Docs workflow validates Antora build only (no Pages publish).
12 changes: 12 additions & 0 deletions changelog-details/2026-08-08 - index-cache-and-backup.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
= 2026-08-08 — Index cache and backup

== Summary

Added a lightweight index cache as the default local store, with opt-in full backup archives for selected repos. Daemon and tray support ongoing monitor sync.

== Details

* Index SQLite under the issues catalogue (`index/index.sqlite`).
* Backup archives under `archives/<host>/<owner>/<repo>/database.sqlite` when enabled.
* CLI flags: `--backup`, `--index-only`, `--set-backup`, `--monitor-add`.
* Daemon IPC on `:17365` (`/open-repo`, `/monitor/set-backup`).
11 changes: 11 additions & 0 deletions changelog-details/2026-08-08 - qt-tray-and-forge-profiles.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
= 2026-08-08 — Qt tray and forge profiles

== Summary

Tray path moved onto a dqt git fork for system tray icons; forge profile loading uses the repo-get DUB package instead of vendored SDL copies.

== Details

* Qt tray via dqt fork / PR path documented for `QSystemTrayIcon`.
* Stopped tracking SDL files copied from the repo-get package; keep `profiles/` copy.
* Fixed `ForgeProfile` name clash with repo-get forge profiles.
Loading