Documentation: Update backlog and changelog

Author: amotl

CHANGES.md

@@ -3,24 +3,24 @@
 ## In progress
 - GitHub/CI: Fixed displaying failed workflow runs on pull requests
   which succeeded afterward
-- GitHub/Important: Improved rendering of Markdown sections
+- GitHub/Bugs: Improved rendering of Markdown sections
 - GitHub/Bugs: Also consider labels `stale` and `type: Bug` as relevant
 
 ## v0.1.0, 2025-02-20
 - Started using `GH_TOKEN` environment variable instead of `GITHUB_TOKEN`,
   see [Authenticate to GitHub in GitHub Actions].
 - Refactored codebase to become a real Python package
 - CI: Added GHA workflow invoking `poe check`, and Dependabot configuration
-- Refactored current adapter code into `rapporto.github`, to accompany
+- GitHub: Refactored current adapter code into `rapporto.github`, to accompany
   including other adapters
 - Added documentation using Sphinx and PyData Sphinx Theme, and RTD.
   See [Rapporto Documentation].
-- Slack: Added thread exporter. Thanks, @WalBeh.
+- Slack: Added conversation exporter. Thanks, @WalBeh.
 - Slack: Refactored CLI to use Click
 - GitHub: Added `GitHubAttentionReport`, to report about important items
   that deserve your attention, bugs first.
-- Options: Make options optional, to report about the complete corpus
-- Links: Display full notation for projects `<org>/<project>`
+- GitHub: Make options optional, to report about the complete corpus
+- GitHub: Display full project names `<org>/<project>` within Markdown links
 
 [Authenticate to GitHub in GitHub Actions]: https://josh-ops.com/posts/gh-auth-login-in-actions/
 [Rapporto Documentation]: https://rapporto.readthedocs.io/

docs/backlog.md

@@ -1,22 +1,19 @@
 # Backlog
 
 ## Iteration +1
-- Publish package to PyPI
+- Opsgenie: Add subsystem
+- GitHub: Export conversations
+- Refactoring: Spread GitHub modules along the feature axis
 
 ## Iteration +2
-- Options: Make `limit=100` configurable. Is paging needed?
-- Documentation: Recipes how to relay reports to messenger channels
-- Data: Search items with significant reactions
-- Data: Search items with EPIC or other keywords in its titles
-- Data: Search for assignments
-- Report: On the CI report, render sections only conditionally
-- Report: On HTML links, always include the org name as prefix
-- GitHub/CI: Can the retrieval process be optimized, not needing to iterate
-  repositories manually?
-- GitHub/Bugs: More flexible processing of "labels" vs. "sections",
-  i.e. improve grouping code, making it more maintainable.
+- GitHub/CI: Currently lacks parameter `--timerange`
+- GitHub: Search items with significant amounts of reactions
+- GitHub: Search items with significant (amount or length of) comments
+- GitHub: Search items with EPIC or other keywords in its titles
+- GitHub: Search items with people assignments
 - GitHub/API: On errors, the JSON response includes the reason as an
   error message. However, it isn't displayed, yet.
+- Options: Make `limit=100` configurable? Is paging needed?
 
 ## Iteration +3
 - Data: Identify items with high conversation activity (comment frequency, etc.)
@@ -29,6 +26,14 @@
   corresponding time range.
 - Report: Make configurable if Rapporto shall only return a share of top changes,
   or each one. Currently, the default is 2/5, but 1/3 is also reasonable.
+- GitHub/Bugs: Also consider issues flagged with `Type: Bug`,
+  orthogonal to GitHub's "labels".
+  - Examples:
+    - https://github.com/crate/cratedb-prometheus-adapter/issues/176
+    - https://github.com/tech-writing/sphinx-design-elements/issues/128
+  => Currently there is no API for this attribute yet.
+  - https://github.com/orgs/community/discussions/140874
+  - https://github.com/orgs/community/discussions/139933
 
 ## Done
 - Make it work.
@@ -40,3 +45,13 @@
 - Documentation: Baseline
 - Added basic
 - Options: Make options optional, to report about the complete corpus
+- Publish package to PyPI
+- Report: On the CI report, render sections only conditionally
+- GitHub/CI: Can the retrieval process be optimized, not needing to iterate
+  repositories manually? No: The GitHub API is per-repository.
+- Report: On HTML links, always include the org name as prefix
+- GitHub/Bugs: Add `stale` label
+- GitHub/Bugs: More flexible processing of "labels" vs. "sections",
+  i.e. improve grouping code, making it more maintainable.
+- GitHub/Bugs: Add label `type: Bug`
+- Documentation: Include breadcrumbs into static docs, not just README

pyproject.toml

@@ -131,8 +131,8 @@ optional-dependencies.test = [
   "pytest-cov<7",
 ]
 
-urls.Issues = "https://github.com/tech-writing/rapporto/issues"
 urls.Documentation = "https://rapporto.readthedocs.io/"
+urls.Issues = "https://github.com/tech-writing/rapporto/issues"
 urls.Repository = "https://github.com/tech-writing/rapporto"
 
 scripts.rapporto = "rapporto.cli:cli"