chore: some readme and docs cleanup (#56)

* update classifiers

* remove commented section for now

* update readme badges and links

* rename persons section to person sampling

Author: johnnygreco

README.md

@@ -2,7 +2,7 @@
 
 [![CI](https://github.com/NVIDIA-NeMo/DataDesigner/actions/workflows/ci.yml/badge.svg)](https://github.com/NVIDIA-NeMo/DataDesigner/actions/workflows/ci.yml)
 [![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
-[![Python 3.10+](https://img.shields.io/badge/python-3.10+-blue.svg)](https://www.python.org/downloads/) [![NeMo Microservices](https://img.shields.io/badge/NeMo-Microservices-76b900)](https://docs.nvidia.com/nemo/microservices/latest/index.html)
+[![Python 3.10 - 3.13](https://img.shields.io/badge/🐍_Python-3.10_|_3.11_|_3.12_|_3.13-blue.svg)](https://www.python.org/downloads/) [![NeMo Microservices](https://img.shields.io/badge/NeMo-Microservices-76b900)](https://docs.nvidia.com/nemo/microservices/latest/index.html) [![Code](https://img.shields.io/badge/Code-Documentation-8A2BE2.svg)](https://nvidia-nemo.github.io/DataDesigner/)
 
 **Generate high-quality synthetic datasets from scratch or using your own seed data.**
 
@@ -98,10 +98,12 @@ preview.display_sample_record()
 
 ### 📚 Learn more
 
-- **[Quick Start Guide](https://nvidia-nemo.github.io/DataDesigner)** – Detailed walkthrough with more examples
-- **[Tutorial Notebooks](https://nvidia-nemo.github.io/DataDesigner/notebooks/1-the-basics/)** – Step-by-step interactive tutorials
+- **[Quick Start Guide](https://nvidia-nemo.github.io/DataDesigner/quick-start/)** – Detailed walkthrough with more examples
+- **[Tutorial Notebooks](https://nvidia-nemo.github.io/DataDesigner/notebooks/intro/)** – Step-by-step interactive tutorials
 - **[Column Types](https://nvidia-nemo.github.io/DataDesigner/concepts/columns/)** – Explore samplers, LLM columns, validators, and more
+- **[Validators](https://nvidia-nemo.github.io/DataDesigner/concepts/validators/)** – Learn how to validate generated data with Python, SQL, and remote validators
 - **[Model Configuration](https://nvidia-nemo.github.io/DataDesigner/models/model-configs/)** – Configure custom models and providers
+- **[Person Sampling](https://nvidia-nemo.github.io/DataDesigner/concepts/persons/)** – Learn how to sample realistic person data with demographic attributes
 
 ### 🔧 Configure models via CLI
 
@@ -114,11 +116,26 @@ data-designer config list      # View current settings
 ### 🤝 Get involved
 
 - **[Contributing Guide](https://nvidia-nemo.github.io/DataDesigner/CONTRIBUTING.md)** – Help improve Data Designer
-- **[GitHub Issues](https://github.com/NVIDIA-NeMo/DataDesigner/issues)** – Report bugs or request features
-- **[GitHub Discussions](https://github.com/NVIDIA-NeMo/DataDesigner/discussions)** – Ask questions and share ideas
+- **[GitHub Issues](https://github.com/NVIDIA-NeMo/DataDesigner/issues)** – Report bugs or make a feature request
 
 ---
 
 ## License
 
 Apache License 2.0 – see [LICENSE](LICENSE) for details.
+
+---
+
+## Citation
+
+If you use NeMo Data Designer in your research, please cite it using the following BibTeX entry:
+
+```bibtex
+@misc{nemo-data-designer,
+  author = {The NeMo Data Designer Team},
+  title = {NeMo Data Designer: A framework for generating synthetic data from scratch or based on your own seed data},
+  howpublished = {\url{https://github.com/NVIDIA-NeMo/DataDesigner}},
+  year = {2025},
+  note = {GitHub Repository},
+}
+```

docs/concepts/persons.md docs/concepts/person_sampling.mddocs/concepts/persons.md renamed to docs/concepts/person_sampling.md

@@ -62,7 +62,7 @@ Person samplers accept these configuration parameters:
 * `locale`: Language and region code (optional, e.g., "en\_US", "ja\_JP", "hi\_IN", "en\_IN")
 * `city`: Filter on cities within the specified locale (optional)
 * `age_range`: Age range for filtering (default: ages above 18 only)
-* `state`: Filter on US states, only valid when locale is set to "en\_US" (optional)
+* `select_field_values`: Filter on specific field values (optional)
 
 **Synthetic Personas Configuration:**
 

mkdocs.yml

@@ -10,8 +10,7 @@ nav:
   - Concepts:
       - Columns: concepts/columns.md
       - Validators: concepts/validators.md
-      - Persons: concepts/persons.md
-      # - Plugins: concepts/plugins.md
+      - Person Sampling: concepts/persons.md
   - Models:
       - Default Model Settings: models/default-model-settings.md
       - Configure with the CLI: models/configure-model-settings-with-the-cli.md

pyproject.toml

@@ -4,15 +4,15 @@ dynamic = ["version"]
 description = "General framework for synthetic data generation"
 readme = "README.md"
 requires-python = ">=3.10"
+license = "Apache-2.0"
 
 classifiers = [
   "Development Status :: 4 - Beta",
   "Intended Audience :: Developers",
   "Intended Audience :: Science/Research",
   "Topic :: Scientific/Engineering :: Artificial Intelligence",
-  "Topic :: Scientific/Engineering :: Human Machine Interfaces",
   "Topic :: Software Development",
-  "License :: Other/Proprietary License",
+  "License :: OSI Approved :: Apache Software License",
   "Programming Language :: Python :: 3.10",
   "Programming Language :: Python :: 3.11",
   "Programming Language :: Python :: 3.12",