Skip to content
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.

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

docs: add essentials section for Transactions #1961

Merged
merged 62 commits into from
Apr 15, 2024

Conversation

danielbate
Copy link
Member

Closes #1923

This PR introduces a section to the essentials docs around Transactions. It includes pages on the following:

  • Transaction Request
  • Transaction Response
  • Transaction Parameters
  • Transaction Policies

It also crosslinks parameters with contract call parameters hence having removed that page in contracts. I have not included custom transactions as I think transaction request adds enough information on this, and we have the cookbooks.

@danielbate danielbate added the docs Requests pertinent to documentation label Mar 27, 2024
@danielbate danielbate self-assigned this Mar 27, 2024
@danielbate danielbate marked this pull request as ready for review March 27, 2024 17:22
Copy link
Contributor

@petertonysmith94 petertonysmith94 left a comment

Choose a reason for hiding this comment

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

  • For me, whitespace between the comments on the docs-snippets, would be easier on the eyes. Feels crowded to me - see here.
  • Also, it appears that types aren't being imported correctly in the final render.

I would favour omitting types from docs-snippets, so then they can be leveraged by both JavaScript and TypeScript developers, what are your thoughts?

danielbate and others added 4 commits March 28, 2024 11:08
Co-authored-by: Nedim Salkić <[email protected]>
Co-authored-by: Nedim Salkić <[email protected]>
Co-authored-by: Nedim Salkić <[email protected]>
@danielbate danielbate dismissed stale reviews from Torres-ssf and petertonysmith94 via fd94e8f April 5, 2024 11:04
@danielbate danielbate requested a review from Dhaiwat10 April 12, 2024 11:27
Copy link
Contributor

Coverage Report:

Lines Branches Functions Statements
79.38%(+0%) 69.67%(+0%) 77.33%(+0%) 79.53%(+0%)
Changed Files:

Coverage values did not change👌.

@danielbate danielbate enabled auto-merge (squash) April 15, 2024 09:45
@danielbate danielbate merged commit 917a57d into master Apr 15, 2024
15 checks passed
@danielbate danielbate deleted the db/docs/transactions-contracts branch April 15, 2024 09:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Requests pertinent to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docs: Transactions
6 participants