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

[RFE] Create FAQ for common Q&A #5520

Closed
clay-aptos opened this issue Nov 9, 2022 · 13 comments · Fixed by #6417
Closed

[RFE] Create FAQ for common Q&A #5520

clay-aptos opened this issue Nov 9, 2022 · 13 comments · Fixed by #6417
Assignees
Labels
documentation Improvements or additions to documentation P1 Priority 1 Stale

Comments

@clay-aptos
Copy link
Contributor

🐛 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 clay-aptos added bug Something isn't working documentation Improvements or additions to documentation P1 Priority 1 labels Nov 9, 2022
@clay-aptos
Copy link
Contributor Author

Adding @davidiw and @geekflyer as an FYI.

@geekflyer geekflyer removed the bug Something isn't working label Nov 9, 2022
@clay-aptos
Copy link
Contributor Author

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
Copy link
Contributor Author

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

@clay-aptos
Copy link
Contributor Author

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:
#4748

@clay-aptos
Copy link
Contributor Author

The team suggests we add these directly to Stack Overflow.

@clay-aptos
Copy link
Contributor Author

I would love help!

@clay-aptos clay-aptos moved this to 🆕 New in Aptos Docs Jan 6, 2023
@clay-aptos clay-aptos moved this from 🆕 New to 📋 Need input in Aptos Docs Jan 9, 2023
@clay-aptos
Copy link
Contributor Author

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.

@davidiw
Copy link
Contributor

davidiw commented Jan 10, 2023

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.

@clay-aptos
Copy link
Contributor Author

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
Copy link
Contributor Author

I am working on an FAQ page under a new Contribute section amalgamating our internal FAQ and aforementioned partner doc:
#6417

@clay-aptos clay-aptos moved this from 📋 Need input to 🏗 In progress in Aptos Docs Feb 3, 2023
@clay-aptos
Copy link
Contributor Author

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!

@github-project-automation github-project-automation bot moved this from 🏗 In progress to ✅ Done in Aptos Docs Mar 7, 2023
@github-project-automation github-project-automation bot moved this from 🎉 New to ✅ Done in Developer Platform Mar 7, 2023
@clay-aptos
Copy link
Contributor Author

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

@clay-aptos clay-aptos reopened this Mar 7, 2023
@clay-aptos clay-aptos moved this from ✅ Done to 🎉 New in Developer Platform Mar 9, 2023
@clay-aptos clay-aptos moved this from ✅ Done to 🆕 New in Aptos Docs Mar 9, 2023
@clay-aptos clay-aptos moved this from 🆕 New to 📋 Need input in Aptos Docs Mar 9, 2023
@clay-aptos clay-aptos moved this from 📋 Need input to 🏗 In progress in Aptos Docs Mar 9, 2023
@github-actions
Copy link
Contributor

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 github-actions bot added the Stale label Apr 22, 2023
@davidiw davidiw closed this as completed Apr 22, 2023
@github-project-automation github-project-automation bot moved this from 🎉 New to ✅ Done in Developer Platform Apr 22, 2023
@github-project-automation github-project-automation bot moved this from 🏗 In progress to ✅ Done in Aptos Docs Apr 22, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation P1 Priority 1 Stale
Projects
Archived in project
Archived in project
6 participants