feat: paycrest documentation for contracts and API#1
Open
Atanda1 wants to merge 10 commits intopaycrest:mainfrom
Open
feat: paycrest documentation for contracts and API#1Atanda1 wants to merge 10 commits intopaycrest:mainfrom
Atanda1 wants to merge 10 commits intopaycrest:mainfrom
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
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.
Description
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 theGatewaycontract documentation.docs/contracts/index.md: Introduced a new section for contracts documentation.Issue and Pull Request Templates:
.github/ISSUE_TEMPLATE/Bug_report.md: Added a new bug report template to guide users in reporting issues effectively..github/ISSUE_TEMPLATE/Feature_request.md: Added a new feature request template to collect detailed information about requested features..github/PULL_REQUEST_TEMPLATE.md: Added a new pull request template to ensure comprehensive descriptions and testing details for new PRs.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
mainBy 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.mdfile.