[Contributor Doc] Type System CheatSheet

[Convly]

What does it do?

Init a cheatsheet for the type system in the contributor documentation

Note: This is honestly just a start. If you've any idea of what could/should/must be added, don't hesitate to comment

How to test it?

• cd docs
• yarn install && yarn start
• head to guides > type system > cheatsheet

[vercel]

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

Name	Status	Preview	Comments	Updated (UTC)
contributor-docs	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Apr 26, 2024 0:45am

[innerdvations]

Good start, this will be helpful!

Can you make sure to run yarn prettier:write on this?

Or I'd be super happy if you could find out why your editor doesn't automatically do it on save, because this has been happening to a lot of people (myself included) seemingly randomly ever since I upgraded to prettier v3. There's definitely something odd going on but I haven't been able to figure it out.

[innerdvations]

Can you give a code example with a return to see when this might be used?

[Convly]

Not sure I understand completely what you're referring too? Do you want an actual body definition for the function?

[innerdvations]

Yeah, like a use case showing what you would select in order to want to return a generic Data.Entity. Not important though, just a thought.

[innerdvations]

Prettier is still failing, do we need the fix you did on v5/main?

And furthermore, is there something broken with yarn prettier:write in regards to ts docs that we can address (perhaps outside this PR)?

[Convly]

Prettier is still failing, do we need the fix you did on v5/main?

And furthermore, is there something broken with yarn prettier:write in regards to ts docs that we can address (perhaps outside this PR)?

We need to understand how to make prettier really understand mdx (because that's not the case currently)

For now everything works well with the exception of 1 prettier-ignore block comment. We can add a note/task to look at this later

[innerdvations]

LGTM!

[innerdvations]

Yeah, like a use case showing what you would select in order to want to return a generic Data.Entity. Not important though, just a thought.

[hanpaine]

Prettier is still failing, do we need the fix you did on v5/main?
And furthermore, is there something broken with yarn prettier:write in regards to ts docs that we can address (perhaps outside this PR)?

We need to understand how to make prettier really understand mdx (because that's not the case currently)

For now everything works well with the exception of 1 prettier-ignore block comment. We can add a note/task to look at this later

I saw Piwi mention that prettier isn't great for documentation as it will often flag a deliberate formatting 'error' that we want there - same situ?

[innerdvations]

I saw Piwi mention that prettier isn't great for documentation as it will often flag a deliberate formatting 'error' that we want there - same situ?

Here it's a bit more complicated, but the gist of it is that we've never spent time really configuring it for our docs. So sometimes it gets in the way a bit. We'll hopefully get a chance to improve that soon.