cairo-contracts icon indicating copy to clipboard operation
cairo-contracts copied to clipboard

Enhance account documentation with utility functions and examples

Open markv44 opened this issue 9 months ago • 12 comments

  • Updated the accounts.adoc file to correct minor formatting issues in usage examples.
  • Added a new section on Account Utilities in the account.adoc file, detailing utility functions for executing calls, validating signatures, and verifying transaction versions.
  • Included comprehensive descriptions of utility functions and constants related to account management.

Fixes #1016

PR Checklist

  • [ ] Tests
  • [X] Documentation
  • [ ] Added entry to CHANGELOG.md
  • [ ] Tried the feature on a public network

markv44 avatar Apr 05 '25 08:04 markv44

hello @ericnordelo , the pull request is ready for review please review it when you have time.

markv44 avatar Apr 05 '25 08:04 markv44

Hey @markv44. Thanks for taking the time to contribute! We will go through the PR and give some feedback later this week.

ericnordelo avatar Apr 07 '25 13:04 ericnordelo

Hey @ericnordelo soft reminder to review the pr. Thanks again. Cheers

markv44 avatar Apr 11 '25 11:04 markv44

Hey @markv44. You can check how the docs would look by going to the Deploy Preview action executed in the PR for the latest commit. If you go there, you can see there's a few broken sections that we need to handle. After that, I will leave feedback about the structure and the content. Thanks for the patience!

ericnordelo avatar Apr 13 '25 18:04 ericnordelo

Hi @ericnordelo , I checked the Deploy Preview for accounts.adoc. The "Account Utilities" section has rendering issues, specifically with ++ and [.item-kind] showing up raw for function/constant types.

Could you point me to the correct AsciiDoc syntax or an example in the docs for formatting these definitions? Thanks!

markv44 avatar Apr 14 '25 18:04 markv44

Hey @markv44, on the same page where you added the Account Utilities there are examples on how to use the attributes in the right way.

ericnordelo avatar Apr 25 '25 09:04 ericnordelo

Hello @ericnordelo , would you please take a look at the CI failures, I dont think they are related to my code changes, if I missed something please advice how should I fix them.

markv44 avatar Apr 29 '25 18:04 markv44

Hey @ericnordelo I have changed the merging issues but now the tests are failing, can you please check why the test are failing?

markv44 avatar May 01 '25 08:05 markv44

Hey @ericnordelo its been a while. I'm having difficulty fixing the broken tests. Can you please take a look? Thank you.

markv44 avatar May 08 '25 15:05 markv44

Hey. Tests should be fixed if you merge main into the PR, since the issue is with the new version of foundry.

If you go to the deploy preview, though, you can see that there are still broken references in the UI from the updates in this PR, like here. You should be able to run the doc-site locally to check the presentation.

ericnordelo avatar May 08 '25 16:05 ericnordelo

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 92.78%. Comparing base (05d5adf) to head (b347274). Report is 11 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1403   +/-   ##
=======================================
  Coverage   92.78%   92.78%           
=======================================
  Files          78       78           
  Lines        2093     2093           
=======================================
  Hits         1942     1942           
  Misses        151      151           

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update 05d5adf...b347274. Read the comment docs.

:rocket: New features to boost your workflow:
  • :snowflake: Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

codecov[bot] avatar May 08 '25 22:05 codecov[bot]

Hi @ericnordelo, Its been a while. Could you please give this pr a proper review now that the ci has been fixed?

markv44 avatar Jun 12 '25 15:06 markv44