Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added FAQ Page #1479

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

Added FAQ Page #1479

wants to merge 6 commits into from

Conversation

PhoneDroid
Copy link

@PhoneDroid PhoneDroid commented Jul 18, 2023


As with any bigger open source project I'm quite
concerned about the count of issues / discussions.

While Fresh is still on the 'lower' side,
I can easily see it getting worse quickly.

To this end I would like to propose - for one -
to extract questions and answers from both
places into a dedicated FAQ and with it,
close the source tickets / discussions.

Steps

  • Add FAQ route
  • Collect questions & answers
  • Process and write them out
  • Close source issues / discussions

To Be Closed

Discussions that can be closed once the FAQ is merged.


image


@PhoneDroid PhoneDroid marked this pull request as ready for review July 27, 2023 19:42
@PhoneDroid PhoneDroid changed the title [ Draft ][ Documentation ] Added FAQ Page Jul 30, 2023
@@ -13,5 +13,8 @@
},
"test": {
"exclude": ["www/"]
},
"fmt": {
"exclude": ["docs/faq.md"]
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why does this file need to be excluded from formatting?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The autoformatting breaks markdown syntax.
I'll happily take the role of janitor for that file ;3

docs/faq.md Outdated Show resolved Hide resolved
www/routes/faq.tsx Outdated Show resolved Hide resolved
www/routes/faq.tsx Outdated Show resolved Hide resolved
www/routes/faq.tsx Outdated Show resolved Hide resolved

#### Do you offer **i18** support

Not yet, it's on the **[Roadmap]**, however not as a top priority.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This makes it sound i18n wouldn't be possible with Fresh. Sure, we don't have some helpers that make it nicer, but any website can add i18n support without helper functions from the framework.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How about this instead?
image

Comment on lines +30 to +36
You can find **Marvin** on the following platforms:

- Discord **@marvin_h** for quick questions

- **[GitHub][Discussions]** for longer form discussions
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think this is a good idea. Other users can help other users too. Pointing everyone in my direction means I'll be likely bombarded with support requests that others can help with too.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How about this?
image

@lucacasonato lucacasonato changed the title [ 𝗗𝗼𝗰𝘂𝗺𝗲𝗻𝘁𝗮𝘁𝗶𝗼𝗻 ][ 𝓡𝓮𝓿𝓲𝓮𝔀 𝓡𝓮𝓺𝓾𝓲𝓻𝓮𝓭 ] Added FAQ Page Jul 31, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
3 participants