fix: markdown formatting to make MkDocs happy (#59)

* fix: markdown formatting to make MkDocs happy

* fix contributing guide link in README

Author: pimlock

CONTRIBUTING.md

@@ -88,94 +88,97 @@ Data Designer uses [`uv`](https://github.com/astral-sh/uv) for dependency manage
 ### Initial Setup
 0. **Create or find an issue**
 
-   Before starting work, ensure there's an issue tracking your contribution:
-   - For bug fixes: Search [existing issues](https://github.com/NVIDIA-NeMo/DataDesigner/issues) or [create a new one](https://github.com/NVIDIA-NeMo/DataDesigner/issues/new)
-   - For new features: Open a [feature request](#feature-requests) to discuss the approach first
-   - Comment on the issue to let maintainers know you're working on it
+    Before starting work, ensure there's an issue tracking your contribution:
+
+    - For bug fixes: Search [existing issues](https://github.com/NVIDIA-NeMo/DataDesigner/issues) or [create a new one](https://github.com/NVIDIA-NeMo/DataDesigner/issues/new)
+    - For new features: Open a [feature request](#feature-requests) to discuss the approach first
+    - Comment on the issue to let maintainers know you're working on it
 
 1. **Fork and clone the repository**
 
-   Start by [forking the Data Designer repository](https://github.com/NVIDIA-NeMo/DataDesigner/fork), then clone your fork and add the upstream remote:
+    Start by [forking the Data Designer repository](https://github.com/NVIDIA-NeMo/DataDesigner/fork), then clone your fork and add the upstream remote:
 
-   ```bash
-   git clone https://github.com/YOUR_GITHUB_USERNAME/DataDesigner.git
+    ```bash
+    git clone https://github.com/YOUR_GITHUB_USERNAME/DataDesigner.git
 
-   cd DataDesigner
+    cd DataDesigner
 
-   git remote add upstream https://github.com/NVIDIA-NeMo/DataDesigner.git
-   ```
+    git remote add upstream https://github.com/NVIDIA-NeMo/DataDesigner.git
+    ```
 
 2. **Install dependencies**
 
-   ```bash
-   # Install project with dev dependencies
-   make install-dev
+    ```bash
+    # Install project with dev dependencies
+    make install-dev
 
-   # Or, if you use Jupyter / IPython for development
-   make install-dev-notebooks
-   ```
+    # Or, if you use Jupyter / IPython for development
+    make install-dev-notebooks
+    ```
 
 3. **Verify your setup**
 
-   ```bash
-   make test && make check-all
-   ```
+    ```bash
+    make test && make check-all
+    ```
 
-   If no errors are reported, you're ready to develop 🚀
+    If no errors are reported, you're ready to develop 🚀
 
 ### Making Changes
 
 1. **Create a feature branch**
 
-   ```bash
-   git checkout main
-   git pull upstream main
-   git checkout -b <username>/<type-of-change>/<issue-number>-<short-description>
-   ```
-
-   Example types of change:
-   - `feat` for new features
-   - `fix` for bug fixes
-   - `docs` for documentation updates
-   - `test` for testing changes
-   - `refactor` for code refactoring
-   - `chore` for chore tasks
-   - `style` for style changes
-   - `perf` for performance improvements
-
-   Example branch name:
-   - `johnnygreco/feat/123-add-xyz-generator` for a new feature by @johnnygreco, addressing issue #123
+    ```bash
+    git checkout main
+    git pull upstream main
+    git checkout -b <username>/<type-of-change>/<issue-number>-<short-description>
+    ```
+
+    Example types of change:
+
+    - `feat` for new features
+    - `fix` for bug fixes
+    - `docs` for documentation updates
+    - `test` for testing changes
+    - `refactor` for code refactoring
+    - `chore` for chore tasks
+    - `style` for style changes
+    - `perf` for performance improvements
+
+    Example branch name:
+
+    - `johnnygreco/feat/123-add-xyz-generator` for a new feature by @johnnygreco, addressing issue #123
 
 2. **Develop your changes**
 
-   Please follow the patterns and conventions used throughout the codebase, as well as those outlined in [AGENTS.md](AGENTS.md).
+    Please follow the patterns and conventions used throughout the codebase, as well as those outlined in [AGENTS.md](AGENTS.md).
 
 3. **Test and validate**
 
-   ```bash
-   make check-all-fix  # Format code and fix linting issues
-   make test           # Run all tests
-   make coverage       # Check test coverage (must be >90%)
-   ```
+    ```bash
+    make check-all-fix  # Format code and fix linting issues
+    make test           # Run all tests
+    make coverage       # Check test coverage (must be >90%)
+    ```
 
-   **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.
+    **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.
 
 4. **Commit your work**
 
-   Write clear, descriptive commit messages, optionally including a brief summary (50 characters or less) and reference issue numbers when applicable (e.g., "Fixes #123").
+    Write clear, descriptive commit messages, optionally including a brief summary (50 characters or less) and reference issue numbers when applicable (e.g., "Fixes #123").
 
-   ```bash
-   git commit -m "Add XYZ generator for synthetic data" -m "Fixes #123"
-   ```
+    ```bash
+    git commit -m "Add XYZ generator for synthetic data" -m "Fixes #123"
+    ```
 
 5. **Stay up to date**
 
-   Regularly sync your branch with upstream changes:
+    Regularly sync your branch with upstream changes:
 
-   ```bash
-   git fetch upstream
-   git merge upstream/main
-   ```
+    ```bash
+    git fetch upstream
+    git merge upstream/main
+    ```
 
 ## Submitting Changes
 
@@ -194,9 +197,9 @@ Ensure your changes meet the following criteria:
 
 1. **Push your changes** to your fork:
 
-   ```bash
-   git push origin <username>/<type-of-change>/<issue-number>-<short-description>
-   ```
+    ```bash
+    git push origin <username>/<type-of-change>/<issue-number>-<short-description>
+    ```
 
 2. **Open a pull request** on GitHub from your fork to the main repository
 

README.md

@@ -115,7 +115,7 @@ data-designer config list      # View current settings
 
 ### 🤝 Get involved
 
-- **[Contributing Guide](https://nvidia-nemo.github.io/DataDesigner/CONTRIBUTING.md)** – Help improve Data Designer
+- **[Contributing Guide](https://nvidia-nemo.github.io/DataDesigner/CONTRIBUTING)** – Help improve Data Designer
 - **[GitHub Issues](https://github.com/NVIDIA-NeMo/DataDesigner/issues)** – Report bugs or make a feature request
 
 ---