aptos-core icon indicating copy to clipboard operation
aptos-core copied to clipboard

[RFE] Create FAQ for common Q&A

Open clay-aptos opened this issue 3 years ago • 9 comments

🐛 RFE

We at Aptos field numerous questions in Discord, Telegram, Slack and elsewhere. We need to form a persistent home for these answers to avoid repetition, inefficiency and fragmentation.

The goal is to get answers from those media in to the FAQ initially and then an even more permanent and findable home in the associated tech docs.

clay-aptos avatar Nov 09 '22 01:11 clay-aptos

Adding @davidiw and @geekflyer as an FYI.

clay-aptos avatar Nov 09 '22 01:11 clay-aptos

Here is my plan of record:

  1. Update and refine internal FAQ.
  2. Reconcile with and update #FAQ channel in Discord: https://discord.com/channels/945856774056083548/951158324345339914
  3. Publish the FAQ to Aptos.dev, under Reference for now.
  4. Link from the top of the Aptos.dev FAQ to Stack Overflow and our Discord FAQ for the live updates and a virtuous cycle.

clay-aptos avatar Nov 17 '22 01:11 clay-aptos

Thanks to @banool , I am noting also the internal GDoc from @movekevin titled "Developer Problems (Discord/Telegram)" we should also consider.

clay-aptos avatar Nov 17 '22 21:11 clay-aptos

We have more fodder, now for app developers, in the form of a Studios Notes GDoc our engineers have compiled we should harvest for the FAQ and NFT tutorial improvements underway in: https://github.com/aptos-labs/aptos-core/issues/4748

clay-aptos avatar Nov 22 '22 17:11 clay-aptos

The team suggests we add these directly to Stack Overflow.

clay-aptos avatar Dec 15 '22 17:12 clay-aptos

I would love help!

clay-aptos avatar Dec 15 '22 17:12 clay-aptos

The team suggests we add these directly to Stack Overflow.

And now @davidiw says we should not use SO. Taking it up with the team to get an answer.

clay-aptos avatar Jan 09 '23 18:01 clay-aptos

I'd recommend Aptos.dev be the definitive site. Asking users to bounce between a site we maintain and a community forum is a bit jarring.

davidiw avatar Jan 10 '23 01:01 davidiw

I'd recommend Aptos.dev be the definitive site. Asking users to bounce between a site we maintain and a community forum is a bit jarring.

Thanks, @davidiw . Please see the internal FAQ I highlighted in our weekly sync for a potential starting point. Would love your thoughts on that.

clay-aptos avatar Jan 26 '23 18:01 clay-aptos

I am working on an FAQ page under a new Contribute section amalgamating our internal FAQ and aforementioned partner doc: https://github.com/aptos-labs/aptos-core/pull/6417

clay-aptos avatar Feb 03 '23 17:02 clay-aptos

I am noting we met this week with the plan of record being some Q&A sessions to fuel this endeavor. Adding @gregnazario and @CapCap to keep me and @christian-aptos in the loop. Thanks!

clay-aptos avatar Feb 17 '23 20:02 clay-aptos

I am reopening as we pulled the FAQ from the Community section PR

clay-aptos avatar Mar 07 '23 17:03 clay-aptos

This issue is stale because it has been open 45 days with no activity. Remove the stale label or comment - otherwise this will be closed in 15 days.

github-actions[bot] avatar Apr 22 '23 01:04 github-actions[bot]