Skip to content

Commit 585df72

Browse files
authored
docs: some link fixes (#65)
* use full links so they work in docs * found more * update link to model configs * swap person sampling for plugins
1 parent 9a33192 commit 585df72

File tree

3 files changed

+6
-16
lines changed

3 files changed

+6
-16
lines changed

CONTRIBUTING.md

Lines changed: 4 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,6 @@ This guide will help you get started with the contribution process.
1212
- [Ways to Contribute](#ways-to-contribute)
1313
- [Feature Requests](#feature-requests)
1414
- [Development Guide](#development-guide)
15-
- [Code Quality Standards](#code-quality-standards)
1615
- [Submitting Changes](#submitting-changes)
1716
- [Code of Conduct](#code-of-conduct)
1817
- [Signing off on your work](#signing-off-on-your-work)
@@ -151,7 +150,7 @@ Data Designer uses [`uv`](https://github.com/astral-sh/uv) for dependency manage
151150
152151
2. **Develop your changes**
153152
154-
Please follow the patterns and conventions used throughout the codebase, as well as those outlined in [AGENTS.md](AGENTS.md).
153+
Please follow the patterns and conventions used throughout the codebase, as well as those outlined in [AGENTS.md](https://github.com/NVIDIA-NeMo/DataDesigner/blob/main/AGENTS.md).
155154
156155
3. **Test and validate**
157156
@@ -161,7 +160,7 @@ Data Designer uses [`uv`](https://github.com/astral-sh/uv) for dependency manage
161160
make coverage # Check test coverage (must be >90%)
162161
```
163162
164-
**Writing tests**: Place tests in [tests/](tests/) mirroring the source structure. Use fixtures from [tests/conftest.py](tests/conftest.py), mock external services with `unittest.mock` or `pytest-httpx`, and test both success and failure cases. See [AGENTS.md](AGENTS.md) for patterns and examples.
163+
**Writing tests**: Place tests in [tests/](https://github.com/NVIDIA-NeMo/DataDesigner/blob/main/tests/) mirroring the source structure. Use fixtures from [tests/conftest.py](https://github.com/NVIDIA-NeMo/DataDesigner/blob/main/tests/conftest.py), mock external services with `unittest.mock` or `pytest-httpx`, and test both success and failure cases. See [AGENTS.md](https://github.com/NVIDIA-NeMo/DataDesigner/blob/main/AGENTS.md) for patterns and examples.
165164
166165
4. **Commit your work**
167166
@@ -216,7 +215,7 @@ Ensure your changes meet the following criteria:
216215
## Code of Conduct
217216
Data Designer follows the Contributor Covenant Code of Conduct. We are committed to providing a welcoming and inclusive environment for all contributors.
218217
219-
**Please read our complete [Code of Conduct](CODE_OF_CONDUCT.md)** for full details on our standards and expectations.
218+
**Please read our complete [Code of Conduct](https://github.com/NVIDIA-NeMo/DataDesigner/blob/main/CODE_OF_CONDUCT.md)** for full details on our standards and expectations.
220219
221220
### License File Headers
222221
All code files that are added to this repository must include the appropriate NVIDIA copyright header:
@@ -228,17 +227,9 @@ All code files that are added to this repository must include the appropriate NV
228227
229228
Use `make update-license-headers` to add headers automatically.
230229
231-
## Getting Help
232-
Need help with your contribution?
233-
234-
- **Documentation**: Check the [documentation](docs/) and [AGENTS.md](AGENTS.md) for additional information
235-
- **Issues**: Browse [existing issues](https://github.com/NVIDIA-NeMo/DataDesigner/issues) for similar questions
236-
- **Contact**: Reach out to the core maintainers at [[email protected]](mailto:[email protected])
237-
238-
239230
## Signing off on your work
240231
241-
When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project license. All contributors are asked to sign the Data Designer [Developer Certificate of Origin (DCO)](DCO) when submitting their first pull request. The process is automated by a bot that will comment on the pull request. Our DCO is the same as the Linux Foundation requires its contributors to sign.
232+
When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project license. All contributors are asked to sign the Data Designer [Developer Certificate of Origin (DCO)](https://github.com/NVIDIA-NeMo/DataDesigner/blob/main/DCO) when submitting their first pull request. The process is automated by a bot that will comment on the pull request. Our DCO is the same as the Linux Foundation requires its contributors to sign.
242233
243234
---
244235

docs/models/default-model-settings.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -92,5 +92,4 @@ Both methods operate on the same files, ensuring consistency across your entire
9292

9393
- **[Configure Model Settings With the CLI](configure-model-settings-with-the-cli.md)**: Learn how to use the CLI to manage model settings.
9494
- **[Quick Start Guide](../quick-start.md)**: Get started with a simple example
95-
- **[Model Configuration Reference](../code_reference/config_builder.md)**: Detailed API documentation
96-
- **[Column Configurations](../code_reference/column_configs.md)**: Learn about all column types
95+
- **[Model Configurations](model-configs.md)**: Learn about model configurations

docs/notebooks/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ Understanding these concepts will help you make the most of the tutorials:
100100

101101
- **[Columns](../concepts/columns.md)** - Learn about different column types (Sampler, LLM, Expression, Validation, etc.)
102102
- **[Validators](../concepts/validators.md)** - Understand how to validate generated data with Python, SQL, and remote validators
103-
- **[Plugins](../concepts/plugins.md)** - Extend Data Designer with custom functionality
103+
- **[Person Sampling](../concepts/person_sampling.md)** - Learn how to sample realistic person data with demographic attributes
104104

105105
### Code Reference
106106

0 commit comments

Comments
 (0)