8000 [chore] Add Docs for bothan-lib by warittornc · Pull Request #113 · bandprotocol/bothan · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

[chore] Add Docs for bothan-lib #113

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 9 commits into
base: main
Choose a base branch
from
Open

[chore] Add Docs for bothan-lib #113

wants to merge 9 commits into from

Conversation

warittornc
Copy link
Member
@warittornc warittornc commented Apr 17, 2025 •
edited
Loading

Implementation details

  • Added cargo docs for bothan-lib
  • Added architecture.md docs

Please ensure the following requirements are met before submitting a pull request:

  • The pull request is targeted against the correct target branch
  • The pull request is linked to an issue with appropriate discussion and an accepted design OR is linked to a spec that describes the work.
  • The pull request includes a description of the implementation/work done in detail.
  • The pull request includes any appropriate unit/integration tests
  • You have added a relevant changelog entry to CHANGELOG.md
  • You have re-reviewed the files affected by the pull request (e.g. using the Files changed tab in the GitHub PR explorer)

@warittornc warittornc changed the base branch from main to refactor-ws April 17, 2025 09:57
@warittornc warittornc marked this pull request as draft April 18, 2025 07:15
@warittornc warittornc marked this pull request as ready for review April 21, 2025 07:27
Base automatically changed from refactor-ws to main April 23, 2025 06:09
@warittornc warittornc force-pushed the add-bothan-lib-docs branch from 292315f to 2d55de9 Compare April 23, 2025 06:30
RogerKSI
RogerKSI reviewed May 2, 2025
View reviewed changes
README.md
Comment on lines +101 to +104
[build-image]: https://placeholder
[build-link]: https://placeholder
[license-image]: https://placeholder
[license-link]: https://placeholder
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

don't have link yet?

README.md
[license-image]: https://placeholder
[license-link]: https://placeholder
[rustc-image]: https://img.shields.io/badge/rustc-stable-blue.svg
[rustc-version]: https://img.shields.io/badge/rustc-1.76+-blue.svg
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

1.76 really works? seems test and docker use 1.85.

README.md
- [`bothan-lib`](bothan-lib/) - Common utilities and shared code
- [`bothan-api`](bothan-api/) - Main API server implementation
- [`bothan-api-proxy`](bothan-api-proxy/) - API proxy for load balancing and caching
- [`bothan-{exchange}`](bothan-binance/) - Exchange-specific implementations
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why link to binance.

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

@RogerKSI RogerKSI RogerKSI left review comments

@taobun taobun Awaiting requested review from taobun

@colmazia colmazia Awaiting requested review from colmazia

@nkitlabs nkitlabs Awaiting requested review from nkitlabs

@tanut32039 tanut32039 Awaiting requested review from tanut32039

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@warittornc @RogerKSI
0