docs about contract structure #7
Conversation
❌ Deploy Preview for aztec-docs-2 failed. Why did it fail? →
|
| - Functions | ||
| - Events | ||
| - See the dedicated section below | ||
| (i am not sure if there should be links throughout this page to the different relevant sections, eg state vars, events, functions, etc., or if we should just do the entire thing in one go with much more detail. i am writing this as if you had never seen a contract in your life and needed to get a sense of how the thing sort of looks to wrap your head around it. there'd be some minor content duplication between this page and the dedicated page in that case - i think that's fine) |
There was a problem hiding this comment.
I think some detail is nice - repetition is the mother of skill after all
I just want to point out here as well, we are targeting Solidity devs so assuming they have never seen an aztec contract in their life is a good assumption. I will also heavily use (and if you wanna add these too then fab but no pressure) Solidity analogies.
We should also link to other sections but devrel can handle this
There was a problem hiding this comment.
We should also link to other sections but devrel can handle this
that's why i've not bothered with links :)
| ## Ciara's notes | ||
|
|
||
| - An overview of the contents (like a bullet point clickable list) | ||
| (i am not entirely sure what'd go here. is this just a repeat of the sidebar with some minor descriptions? do we even need such a thing, specially if we're thinking about having a single scrollable page for the entire contract section in aztecnr?) |
There was a problem hiding this comment.
yeah I don't think you should spend your time on overview pages tbh - we (devrel and I) can handle these pages dw
There was a problem hiding this comment.
oh i more meant that in my mind i'm not really sure we'd even go here
I remvoed
contract-scopeas it just seemed a repeat of what I called 'contract structure'. I am also not sure about the need for an index.Left a comment in contract-structure re. whether we want for that to be a short standalone piece with links, or whether we just want to go all-in. At any point, I think the content there all makes sense to have. I'll go into more detail in future PRs, and we can decide later whether to merge or keep separate.