docs icon indicating copy to clipboard operation
docs copied to clipboard

Update deep-dive-post-conditions.mdx

Open max-crawford opened this issue 1 year ago • 4 comments

I've removed the hyphen from "post conditions" to match the styling of Stacks documentation.

Note: we need to update the sidebar copy as well. Not sure where to do that.

max-crawford avatar Mar 30 '24 21:03 max-crawford

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
hiro-systems-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Mar 30, 2024 9:06pm

vercel[bot] avatar Mar 30 '24 21:03 vercel[bot]

so the official sip uses hyphens when referring to post-conditions throughout, which is why we've tried to continue to do so

reference here: https://github.com/stacksgov/sips/blob/main/sips/sip-005/sip-005-blocks-and-transactions.md#transaction-post-conditions

happy to hear others weigh in though @janniks

ryanwaits avatar Mar 30 '24 21:03 ryanwaits

Happy to do whatever is most official 🤷🏼‍♀️ SIP is good; Stacks Docs does it without hyphens. No strong opinion on my part

janniks avatar Mar 30 '24 21:03 janniks

Oh I didn't realize the SIP used the hyphen. I was matching what I saw here: https://docs.stacks.co/stacks-101/post-conditions

I don't feel strongly about this. My sense is that more people will read Stacks docs than the SIP, so having uniformity between our docs and theirs would be beneficial, but I see the argument for keeping it as well.

max-crawford avatar Mar 30 '24 21:03 max-crawford

closing this for now

ryanwaits avatar Jun 30 '24 17:06 ryanwaits