diff --git a/CHANGELOG.adoc b/CHANGELOG.adoc new file mode 100644 index 0000000..3b9cc30 --- /dev/null +++ b/CHANGELOG.adoc @@ -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]. diff --git a/README.adoc b/README.adoc index 1677ee3..d148b2c 100644 --- a/README.adoc +++ b/README.adoc @@ -3,16 +3,47 @@ ifndef::env-github[:icons: font] :toclevels: 2 :sectanchors: +ifdef::env-github[] +++++ + +
+Contributors +Forks +Stargazers +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 with issuesd + tray.
+Explore the docs »

+Report Bug +· +Request Feature +

+
+++++ +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`) @@ -20,11 +51,54 @@ link:https://github.com/dev-centr/issues-browser/issues[Issues] * **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////database.sqlite`. + +Depth lives in the docs hub (not a secondary Pages site). + +ifdef::env-github[] +++++ +

(back to top)

+++++ +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[] +++++ +

(back to top)

+++++ +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 @@ -32,9 +106,44 @@ 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////database.sqlite`. +Full docs: https://docs.devcentr.org/issues-browser/ + +ifdef::env-github[] +++++ +

(back to top)

+++++ +endif::[] + +== Changelog + +link:CHANGELOG.adoc[Changelog] + +ifdef::env-github[] +++++ +

(back to top)

+++++ +endif::[] == License MIT (application). ProHelp dependency is PCDL 1.0 — see https://github.com/openshellorg/prohelp + +ifdef::env-github[] +++++ +

(back to top)

+++++ +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[] +++++ +

(back to top)

+++++ +endif::[] diff --git a/changelog-details/2026-08 - rename-and-docs-hub.adoc b/changelog-details/2026-08 - rename-and-docs-hub.adoc new file mode 100644 index 0000000..f6a1896 --- /dev/null +++ b/changelog-details/2026-08 - rename-and-docs-hub.adoc @@ -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). diff --git a/changelog-details/2026-08-08 - index-cache-and-backup.adoc b/changelog-details/2026-08-08 - index-cache-and-backup.adoc new file mode 100644 index 0000000..6d74dac --- /dev/null +++ b/changelog-details/2026-08-08 - index-cache-and-backup.adoc @@ -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////database.sqlite` when enabled. +* CLI flags: `--backup`, `--index-only`, `--set-backup`, `--monitor-add`. +* Daemon IPC on `:17365` (`/open-repo`, `/monitor/set-backup`). diff --git a/changelog-details/2026-08-08 - qt-tray-and-forge-profiles.adoc b/changelog-details/2026-08-08 - qt-tray-and-forge-profiles.adoc new file mode 100644 index 0000000..f59e7fd --- /dev/null +++ b/changelog-details/2026-08-08 - qt-tray-and-forge-profiles.adoc @@ -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.