Skip to content

docs: refresh Bitgesell API README links#3

Open
tolga-tom-nook wants to merge 2 commits into
BitgesellOfficial:masterfrom
tolga-tom-nook:docs/refresh-bitgesell-readme-links
Open

docs: refresh Bitgesell API README links#3
tolga-tom-nook wants to merge 2 commits into
BitgesellOfficial:masterfrom
tolga-tom-nook:docs/refresh-bitgesell-readme-links

Conversation

@tolga-tom-nook

@tolga-tom-nook tolga-tom-nook commented May 25, 2026

Copy link
Copy Markdown

Summary

  • updates the README requirement link for pybgl from the old bitaps-com fork to BitgesellOfficial/pybgl
  • refreshes the API documentation link to the canonical BitgesellOfficial/bglapiserver repository
  • replaces remaining Bitcoin-specific README wording in the API module list with Bitgesell-specific wording and fixes nearby grammar
  • polishes the API module descriptions so the singular/plural wording and analytics terminology are consistent across active and crossed-out modules

Validation

  • python3 README stale-link/wording scan passed
  • README Markdown link check: verified bitaps-com/btcapiserver, BitgesellOfficial/pybgl, bitaps-com/aiojsonrpc, and BitgesellOfficial/bglapiserver/tree/master/api all return HTTP 200
  • git diff --check passed

Related bounty program: BitgesellOfficial/bitgesell#81 / BitgesellOfficial/bitgesell#39

Payout address if approved: 0x4a76c7E64C08cF29B59eFC640b4ada97A270d428

Assisted by Hermes Agent.

Executor revalidation 2026-06-18T12:29Z

  • Rechecked bounty issues #39 and #81 are still open.
  • Revalidated README canonical links returned HTTP 200 for bitaps-com/btcapiserver, BitgesellOfficial/pybgl, bitaps-com/aiojsonrpc, and BitgesellOfficial/bglapiserver/tree/master/api.
  • Confirmed stale Bitcoin wording is absent from the refreshed README intro.
  • Ran git diff --check origin/master...HEAD and git rev-list --left-right --count origin/master...HEAD (0 2).

@MyTH-zyxeon

Copy link
Copy Markdown

Maintainer review note for the #81/#39 bounty queue:

I checked head ce28fdda: this is a small docs-only README refresh, separate from the Docker-template change in #2. The useful part is aligning the API server docs with the official Bitgesell repositories and replacing stale Bitcoin wording in module descriptions.

Acceptance checks:

  • Confirm BitgesellOfficial/pybgl, bitaps-com/aiojsonrpc, and BitgesellOfficial/bglapiserver/tree/master/api are the intended public links before merge.
  • Keep this scoped to README wording/link hygiene only; no API module behavior, Docker launch behavior, or dependency versions should change.
  • Review the singular/plural wording changes around Merkle proof, transaction history, mempool analytics, and transaction-fee analytics for maintainer-preferred terminology.
  • Run a lightweight Markdown/link check if available; otherwise a plain README render review is enough for this PR class.

No wallet/key/node/live-chain scope; this should stay a low-risk docs cleanup artifact.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants