Skip to content

Conversation

andrew-fleming
Copy link
Contributor

@andrew-fleming andrew-fleming commented Jul 16, 2025

This PR proposes to improve the fungible token docs continuing from this discussion. It doesn't change the ToC on the right side bar as originally proposed, however

Proposed changes:

  • Add Ledger and Witnesses sections
  • Separate circuits by export vs internal
  • Move internal _update to bottom of module so it matches API

LMK what you guys think and/or if you have other ideas @0xisk @emnul

Fixes #180

Screenshot 2025-07-16 at 12 43 39 AM

@andrew-fleming andrew-fleming requested a review from a team as a code owner July 16, 2025 04:02
@andrew-fleming andrew-fleming added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Jul 16, 2025
@emnul
Copy link
Contributor

emnul commented Jul 18, 2025

So in general we want the order of the API section to match the ordering of the Compact circuits?

@andrew-fleming
Copy link
Contributor Author

So in general we want the order of the API section to match the ordering of the Compact circuits?

I think so unless we have a stronger reason to do it another way

@emnul
Copy link
Contributor

emnul commented Jul 18, 2025

I think we should also have a dependency section to make sure users know to include Initializable and Utils in their project directory . Otherwise the contracts will fail to compile.

@emnul emnul mentioned this pull request Jul 18, 2025
2 tasks
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.

Improve doc design
2 participants