search

credmark / credmark-website

3 stars 1 forks source link

Implement new FAQ #105

Closed murphy closed 2 years ago

murphy commented 2 years ago

https://docs.google.com/document/d/146Q4EVCCXYwjF0eegWQiis-iJOraQ18-MjUP55NkpAU/edit?usp=sharing

I don't know which of you does this so assigning it to both!

murphy commented 2 years ago

Damn, I just remembered that we have another FAQ.

I remember that the original intent was to have a few FAQ items on the website and then use the Gitbook for overflow and questions that required more illustrative answers.

Maintaining something in two places is a pain and likely to lead to mistakes. I'd be in favor of only putting FAQ on website, but you guys may disagree.

Adding @MattCMK to the ticket because I know he will have an opinion.

MattCMK commented 2 years ago

@murphy For me it depends a little on the context. So we might have a FAQ on the access.credmark.com site to answer questions specifically regarding the account setup, payments, receipts, and creating an API key while the FAQ on the website could be more related to general questions around Credmark and the API products and then linking to the respective Gitbooks

murphy commented 2 years ago

Ah, @MattCMK we're talking about two different things.

The old FAQ on access.credmark.com was necessary and non-standard. Now that people are just going to sign up using Stripe, I don't think we need a FAQ there. When we finally introduce the protocol we definitely will.

I was talking about the fact that we have a FAQ on the website and that after each section we have a "Learn More" button that takes you to the Gitbook-hosted FAQ. For most (all?) FAQ sections it's the same content, which must be frustrating to users. For us, it means we have to keep two things in sync.

Anyway, I thought the scheme made sense in theory (less maintenance for Wen-Chiao and Elektra) but in practice it's annoying. Updating the website is fast. And we could even move all the content to the CMS so that we could update it without the need to redeploy the site.

Screen Shot 2022-09-01 at 09 30 47
MattCMK commented 2 years ago

Ah ok, yeah I would get rid of the Gitbook FAQ and let it reside on the website only. otherwise it feels like a break in the UX

murphy commented 2 years ago

OK, glad you agree.

@elektramurphy therefore remove the "Learn More" button. I'll nuke from Gitbook.

elektramurphy commented 2 years ago

@murphy "Learn more" button removed - Any copy updates?

murphy commented 2 years ago

@elektramurphy a ton...see Doc in the original ticket description.