Document all RPC method subdirectories in docs index - #106
Open
kngako wants to merge 1 commit into
Open
Conversation
The docs/rpc/README.md index only listed a subset of the method categories, leaving several documented method groups undiscoverable: - Add the missing Analytics category (analytics/README.md): dashboards and analytical reports covering place statistics, daily infrastructure and request-log reports, and top API consumers. - Add the missing Import category (import/README.md): submission and management of places from trusted external sources, listing the four methods (submit_place, revoke_submitted_place, get_submitted_place, get_place_import_origins) so readers can find the way to add a merchant to the map. - Point each category that has a subdirectory of per-method docs (auth, event, area, invoice, electrum, wallet) at it and summarize the methods it contains. - Remove the Log Methods entry: it linked to log/README.md, which does not exist. The log-related methods (get_request_log, get_daily_infra_report) live under analytics/ and are covered by the new Analytics entry. Every link in the index now resolves to an existing file or directory.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The docs/rpc/README.md index only listed a subset of the method categories, leaving several documented method groups undiscoverable:
Every link in the index now resolves to an existing file or directory.