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

[Feature | Document] add FAQ section in document #155

Open
MooooCat opened this issue Mar 11, 2024 · 2 comments
Open

[Feature | Document] add FAQ section in document #155

MooooCat opened this issue Mar 11, 2024 · 2 comments
Assignees
Labels
difficulty-easy documentation Improvements or additions to documentation good first issue Good for newcomers
Milestone

Comments

@MooooCat
Copy link
Contributor

🚅Search before asking

I have searched for issues similar to this one.

🚅Description

Many users are asking the same or similar questions.

🏕Solution(optional)

We will first collect related/similar/same questions, then summarize them as FAQ in the document.

This will help new users understand sdgx asap, also solve common doubts.

🍰Detail(optional)

Details will be updated in our documentation.

🍰Example(optional)

@MooooCat MooooCat added the good first issue Good for newcomers label Mar 11, 2024
@MooooCat MooooCat added this to the 0.2.1 milestone Mar 11, 2024
@MooooCat MooooCat added documentation Improvements or additions to documentation difficulty-easy labels Mar 11, 2024
@MysteryManav
Copy link

@MooooCat I would like to work on this issue. Can you specify the questions that are to be added ? and what section/page in documentation would you like for it to be added to ?

@MooooCat
Copy link
Contributor Author

Hi MysteryManav @MysteryManav

Sure! For now, I have collected the following frequently asked questions about synthetic data.

You can add them to the FAQ as a reference.

  1. What is synthetic data?
  2. What are the differences between synthetic data and real data?
  3. Why do we need to use synthetic data?
  4. In what situations should synthetic data be used instead of real data?
  5. How to ensure the privacy and security of synthetic data? How to prevent synthetic data from being misused or leaked?

In terms of implementation, I suggest that you add FAQ.rst into docs/source/user_guides, add FAQ links to docs/source/user_guides/index.rst, and add these questions and answers according to the corresponding format.

You can draft some short answers based on the knowledge you already understand.

There are no standard answers to these answers, we can further discuss the content of these answers in the PR.

Feel free to open a PR at any time :)

sirisneupane123 added a commit to sam3179/synthetic-data-generator that referenced this issue Apr 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
difficulty-easy documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants