Skip to content

Commit 1e1d8cb

Browse files
fabclmntfabclmnt
authored
docs: updt contribute guide, logo and colour schema (#281)
* docs: update logos and colour scheme * docs: update README logo. * docs: Add contribute page * docs: update contribute guide & help
1 parent 00724cc commit 1e1d8cb

6 files changed

Lines changed: 57 additions & 18 deletions

File tree

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
[![](https://img.shields.io/pypi/v/ydata-synthetic)](https://pypi.org/project/ydata-synthetic/)
66
![](https://img.shields.io/github/license/ydataai/ydata-synthetic)
77

8-
<p align="center"><img width="200" src="https://user-images.githubusercontent.com/3348134/177604157-11181f6c-57e5-44b1-8f6c-774edbba5512.png" alt="Synthetic Data Logo"></p>
8+
<p align="center"><img width="300" src="https://assets.ydata.ai/oss/ydata-synthetic_black.png" alt="YData Synthetic Logo"></p>
99

1010
Join us on [![Discord](https://img.shields.io/badge/Discord-7289DA?style=for-the-badge&logo=discord&logoColor=white)](https://discord.gg/mw7xjJ7b7s)
1111

‎docs/index.md‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<p></p>
2-
<p align="center"><img width="250" src="https://user-images.githubusercontent.com/3348134/177604157-11181f6c-57e5-44b1-8f6c-774edbba5512.png" alt="YData Logo"></p>
2+
<p align="center"><img width="300" src="https://assets.ydata.ai/oss/ydata-synthetic_black.png" alt="YData Synthetic Logo"></p>
33
<p></p>
44

55
[![pypi](https://img.shields.io/pypi/v/ydata-synthetic)](https://pypi.org/project/ydata-synthetic)
@@ -11,8 +11,6 @@
1111
[![Code Coverage](https://codecov.io/gh/ydataai/ydata-synthetic/branch/master/graph/badge.svg?token=gMptB4YUnF)](https://codecov.io/gh/ydataai/ydata-synthetic)
1212
[![GitHub stars](https://img.shields.io/github/stars/ydataai/ydata-synthetic?style=social)](https://github.com/ydataai/ydata-synthetic)
1313
[![Discord](https://img.shields.io/discord/1037720091376238592?label=Discord&logo=Discord)](https://discord.com/invite/mw7xjJ7b7s)
14-
15-
1614

1715
## Overview
1816
`ydata-synthetic` is the go-to Python package for **synthetic data generation for tabular and time-series data**. It uses the latest Generative AI models to learn the properties of real data and create realistic synthetic data. This project was created to educate the community about synthetic data and its applications in real-world domains, such as data augmentation, bias mitigation, data sharing, and privacy engineering. To learn more about Synthetic Data and its applications, [check this article](https://ydata.ai/resources/10-most-frequently-asked-questions-about-synthetic-data).

‎docs/stylesheets/extra.css‎

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,20 @@
33
}
44
.md-typeset :focus-within > .md-annotation__index > ::before {
55
transform: none;
6-
}
6+
}
7+
8+
:root {
9+
/* Primary color shades */
10+
--md-primary-fg-color: #040404;
11+
--md-primary-fg-color--light: #040404;
12+
--md-primary-fg-color--dark: #040404;
13+
--md-primary-bg-color: hsla(0, 0%, 100%, 1);
14+
--md-primary-bg-color--light: hsla(0, 0%, 100%, 0.7);
15+
--md-text-link-color: #E32212;
16+
17+
/* Accent color shades */
18+
--md-accent-fg-color: #E32212;
19+
--md-accent-fg-color--transparent: hsla(189, 100%, 37%, 0.1);
20+
--md-accent-bg-color: hsla(0, 0%, 100%, 1);
21+
--md-accent-bg-color--light: hsla(0, 0%, 100%, 0.7);
22+
}

‎docs/support/contribute.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
## Contribute
2+
3+
You are always welcome to contribute to this incredible ecosystem for synthetic data generation. We have several areas in that we are always looking for an extra pair of hands to help us get things going:
4+
5+
- **Documentation:** we all love it, but keeping it up-to-date can be challenging! But guess what? This is also the fastest way for you to get to know ydata-synthetic and start contributing! Even if it is missing, like a new example that could help the community go from zero to hero with synthetic data!
6+
- **Getting started:** Issues that use this tag are usually the most friendly for someone that has just begun the journey into open-source contributions. So don't be shy; assign the task to you and introduce yourself in the GitHub issue! We will be there to guide you.
7+
8+
But we always look for contributions that go beyond documentation and fixes
9+
10+
- **Synthetic data for NLP:** If you are an expert or just someone that would like to dive into this topic, we welcome you to participate in a small project around the generation of synthetic text.
11+
- **Synthetic data for images:** if you are a computer vision and you like to share, feel free to add some examples for images!
12+
- Any other research around synthetic data you would like to share with the community is more than welcome! If you want your research to be part of a rich ecosystem, open a PR!
13+
14+
### PR name and convention
15+
For the commit messages, if you could please read this [commit-message guidelines](https://juhani.gitlab.io/go-semrel-gitlab/commit-message/) or [conventional commit messages](https://www.conventionalcommits.org/en/v1.0.0-beta.3/#summary) and follow these conventions, it would be awesome.
16+
17+
### Issues and where I can find more info about contributing
18+
If you need help figuring out where to start or want to learn what other contributors are doing, go to the [Data-Centric AI community Discord](https://discord.com/invite/mw7xjJ7b7s) channel and introduce yourself in the #ydata-synthetic channel.
19+
20+
If you can't find an issue that interests you and wants to add an improvement or change, create a new one.

‎docs/support/help-troubleshooting.md‎

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,15 @@
1-
# Help & Troubleshooting
1+
# Help & Troubleshooting
2+
3+
## Troubleshooting
4+
5+
- Having a hard time installing **ydata-synthetic** on your laptop?
6+
:fontawesome-brands-youtube:{ style="color: #EE0F0F" }
7+
[Installing ydata-synthetic](https://www.youtube.com/watch?v=aESmGcxtBdU) – :octicons-clock-24:
8+
9+
- You still have questions about python versions or how to get started? Check this [blogpost](https://ydata.ai/resources/10-most-asked-questions-on-ydata-synthetic)!
10+
11+
## Community help
12+
13+
If you are just starting, or you are dealing with something new we are always eager to help!
14+
15+
Join us in the [Data-Centric AI community Discord](https://discord.com/invite/mw7xjJ7b7s), we have a space reserved for all your questions about **ydata-synthetic**! Don't be shy 😳

‎mkdocs.yml‎

Lines changed: 3 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ nav:
1313
- Examples: 'getting-started/examples.md'
1414
- Support:
1515
- Help & Troubleshooting: 'support/help-troubleshooting.md'
16-
- Contribution Guidelines: 'support/help-troubleshooting.md'
16+
- Contribution Guidelines: 'support/contribute.md'
1717
- Reference:
1818
- Changelog: 'reference/changelog.md'
1919
- API:
@@ -41,18 +41,9 @@ theme:
4141
palette:
4242
- media: "(prefers-color-scheme: light)"
4343
scheme: default
44-
primary: red
44+
primary: black
4545
accent: pink
46-
toggle:
47-
icon: material/toggle-switch-off-outline
48-
name: Switch to dark mode
49-
- media: "(prefers-color-scheme: dark)"
50-
primary: red
51-
accent: deep orange
52-
scheme: slate
53-
toggle:
54-
icon: material/toggle-switch
55-
name: Switch to light mode
46+
logo: 'https://assets.ydata.ai/oss/ydata-synthetic-_red.png'
5647
features:
5748
- content.code.annotate
5849
- content.tabs.link

0 commit comments

Comments
 (0)