Faq

[mkst]

Creating a PR to gather feedback.

Closes #915

[marijnvdwerf]

(Terse because I’m on mobile. Nice job on adding the faq)

• Textual content should be left aligned instead of justified for easier reading
• Headings should probably have an id/name and way to get a /faq#what-is-a-scratch link
• Wouldn’t it be easier (editing-wise) to have the faq in a md file that gets turned into TS on compile time? (E.g https://nextjs.org/docs/app/building-your-application/configuring/mdx)
• Not sure if the page is long enough, but either a TOC or making sections collapsible could be a good way to help people get the answer they’re looking for
• Some info about the scoring algorithm?
• Maybe the longer paragraphs (good length btw!) could use some emphasis or links to make them a bit more visually engaging.

[marijnvdwerf]

This answer seems unfinished. I think we need to direct people somewhere. Either a feature request issue template, or just Discord?

I think adding issue templates would be a good idea as well. Especially for requests like adding a preset (platform, version, name, flags), or a compiler/platform, so you can get all the required information at once.

[bates64]

A contributing document that explains how to add a new compiler/platform (not preset - they're in the db now!) would be in order

[ethteck]

I agree, but I don't think it should hold up this PR. it's something that can be an issue and later created / linked to from this page

[jpburnett]

Just some thoughts. Not sure if a "How do I make a scratch" would make sense? There is sections explaining that, but that could be more of a tutorial rather than FAQ?

[ethteck]

This is a great start that I think can be improved over time with some of the more QOL features like @marijnvdwerf mentioned. If no one has any objections, I think let's merge this soon