Skip to content

feat: paycrest documentation for contracts and API#1

Open
Atanda1 wants to merge 10 commits intopaycrest:mainfrom
Atanda1:main
Open

feat: paycrest documentation for contracts and API#1
Atanda1 wants to merge 10 commits intopaycrest:mainfrom
Atanda1:main

Conversation

@Atanda1
Copy link
Copy Markdown

@Atanda1 Atanda1 commented Feb 19, 2025

Description

Documentation Updates:

  • docs/api.md: Added comprehensive API documentation, including endpoints for fetching token rates, verifying accounts, fetching supported institutions and currencies, and managing payment orders.
  • docs/contracts/Gateway.md: Improved formatting and added missing details to the Gateway contract documentation.
  • docs/contracts/index.md: Introduced a new section for contracts documentation.

Issue and Pull Request Templates:

Code Owners:

  • .github/CODEOWNERS: Assigned default code owners for the repository to streamline the review process.

README.md Restructuring:

  • README.md: Updated the file to provide a clearer description of the project and removed outdated deployment instructions. [1] [2]

Checklist

  • I have added documentation and tests for new/changed functionality in this PR
  • All active GitHub checks for tests, formatting, and security are passing
  • The correct base branch is being used, if not main

By submitting a PR, I agree to Paycrest's Contributor Code of Conduct and Contribution Guide.
This pull request includes several updates to documentation, issue templates, and code owners. The most important changes include the addition of new API documentation, updates to issue and pull request templates, and the restructuring of the README.md file.

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.

1 participant