Clarify and structure API documentation with TOC and endpoint headers#619
Open
elhadjikande123 wants to merge 1 commit intoBTCTrader:masterfrom
Open
Clarify and structure API documentation with TOC and endpoint headers#619elhadjikande123 wants to merge 1 commit intoBTCTrader:masterfrom
elhadjikande123 wants to merge 1 commit intoBTCTrader:masterfrom
Conversation
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
1 participant
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.
Pull Request: Clarify and Structure the API Documentation
Motivation
The current API documentation contains valuable information but lacks a clear and consistent structure.
As the documentation grows, it becomes harder for developers—especially new users—to quickly locate relevant endpoints and understand the overall API layout.
This pull request focuses on improving documentation clarity and navigation without altering any existing API behavior or content.
What has been done
Added a Table of Contents (TOC) at the top of the main documentation file.
Reorganized endpoints into clear, logical categories:
Public API
Authentication
Account & Wallet
Orders
Standardized section titles using explicit endpoint headers (e.g. ### GET /api/v2/ticker).
Improved Markdown formatting for better readability and consistency.
Preserved all existing documentation content while enhancing its structure.
Impact
Makes the documentation easier to browse and understand.
Helps new developers onboard faster.
Improves long-term maintainability of the documentation.
No breaking changes and no functional impact on the API.
Checklist
Added Table of Contents
Grouped endpoints by category
Standardized endpoint headers
Verified Markdown rendering
Tested TOC anchor links
Reviewed for grammar and formatting