How bitbankinc/bitbank-api-docs works
Main Components
• API Documentation Sections – The repository is divided into several markdown files that each describe a specific part of the bitbank API ecosystem:
• rest-api.md and rest-api_JP.md: Details on the Private REST API.
• public-api.md and public-api_JP.md: Details on the Public API.
• public-stream.md and public-stream_JP.md: Details on available real time streams API.
• errors.md and errors_JP.md: Descriptions of possible error messages from the Private REST API.
• Ancillary Files and Resources:
• assets.md, networks.md, and pairs.md: These likely provide supplementary information for using the APIs.
• CHANGELOG.md: Keeps track of changes, updates, and maintenance activities.
• GitHub configuration files (e.g., ISSUE_TEMPLATE.md, PULL_REQUEST_TEMPLATE.md): Used for managing contributions and issue tracking.
Understand the Relationships and Interactions
• All the documentation files are interconnected under the umbrella of “Official Documentation for the bitbank.cc APIs and Streams.”
• Supporting documentation (assets, networks, pairs) and versioning (CHANGELOG) can be shown as peripheral components that enhance understanding and historical context.
Architectural Principles
• Modularity: The design is split into many markdown files, each focusing on a specific area – this naturally suggests a modular architecture where each document/component stands alone yet interconnects with others.
• Internationalization: The presence of Japanese versions (README_JP.md, errors_JP.md, public-api_JP.md, etc.) shows a design accommodating multiple languages.
• Documentation-as-Code: The project leverages version control (with configuration files in .github) and automated issue tracking, emphasizing a workflow-driven, community-collaboration model.
Elements
• Clear Labels: Each component (node) should be clearly labeled with the documentation file or the feature it represents.
• The “Private REST API” node connecting to the “Errors” node.
• All API documentation nodes funneling into the central “bitbank.cc API Documentation” node.
• Core API documentation (e.g., rectangular nodes) from supporting materials (e.g., oval nodes).
• Documentation for different languages (e.g., primary language vs. internationalization components).