Skip to content

fix: Restore offline file delivery section, update pre commit hook from Docusaurus to Mintlify build check#215

Merged
bokelley merged 8 commits into
mainfrom
restore-offline-file-delivery-section
Nov 18, 2025
Merged

fix: Restore offline file delivery section, update pre commit hook from Docusaurus to Mintlify build check#215
bokelley merged 8 commits into
mainfrom
restore-offline-file-delivery-section

Conversation

@BaiyuScope3

@BaiyuScope3 BaiyuScope3 commented Nov 18, 2025

Copy link
Copy Markdown
Collaborator

Summary

This PR restores the "Offline File Delivery (Batch)" section that was removed in PR #203 and updates the pre-push validation to use Mintlify instead of Docusaurus.

  • Restored comprehensive format examples for JSONL, CSV, and Parquet formats
  • Fixed empty space issue at #offline-file-delivery-batch anchor
  • Reordered the Delivery Methods section to make the structure more reasonable - Delivery Methods is now the parent section with Webhook-Based Reporting and Offline-File-Delivery-Based Reporting as subsections
  • Updated pre-push hook to validate with Mintlify (broken links and accessibility checks) instead of Docusaurus build
  • Aligned validation with production system (Mintlify)
  • Added missing fields (notification_type, sequence_number, next_expected_at) to all offline file format examples
  • Updated CSV format to use dot notation (by_package.pricing_model, totals.impressions)

Documentation Fixes

  • Restored "Offline File Delivery (Batch)" section - Previously removed due to MDX parsing errors
  • Fixed tab syntax compatibility - Switched from Docusaurus TabItem to Mintlify <Tab> syntax
  • Added comprehensive format examples - JSONL, CSV, and Parquet formats with detailed examples and file naming conventions
  • Fixed empty space issue - Resolves the empty section at #offline-file-delivery-batch anchor

Infrastructure Changes

  • Updated pre-push hook validation:
    • Removed Docusaurus build check (production uses Mintlify)
    • Added Mintlify broken links validation (fails on broken internal links)
    • Added Mintlify accessibility check (warns on a11y issues, non-blocking)
  • Aligned validation with production - Pre-push now validates using the same system as production

Technical Details

Why it was removed before:

Solution:

  • Use Mintlify-native <Tab> components (no imports needed)
  • Validate with Mintlify tools instead of Docusaurus build
  • Ensures documentation works in production (Mintlify) before pushing

Test Plan

  • ✅ All schema validation tests pass
  • ✅ TypeScript compilation succeeds
  • ✅ Mintlify broken links check passes (no broken links found)
  • ✅ Mintlify accessibility check runs (warns on color contrast, non-blocking)
  • ✅ 88 MDX files validated successfully
  • ✅ Pre-push hook validation passes
  • ✅ Section renders correctly in Mintlify (no empty space at anchor)

Files Changed

  • docs/media-buy/media-buys/optimization-reporting.mdx - Restored section with Mintlify-compatible tabs (+129 lines)
  • .husky/pre-push - Updated validation to use Mintlify instead of Docusaurus

…atible tabs

- Restore the Offline File Delivery (Batch) section that was removed in PR #203
- Use Mintlify-compatible Tabs syntax (production system)
- Add comprehensive examples for JSONL, CSV, and Parquet formats
- Fixes empty space issue at #offline-file-delivery-batch anchor

Note: Uses Mintlify syntax for production deployment. Pre-commit Docusaurus build may need adjustment.
Production uses Mintlify, not Docusaurus. Docusaurus build fails on Mintlify-specific syntax like <Tab> components. This allows Mintlify-compatible documentation to be pushed without build failures.
Replace Docusaurus build with Mintlify validation:
- Check for broken internal links (fails on errors)
- Check for accessibility issues (warns only)

This ensures documentation is valid for Mintlify (production system) before pushing.
…nation

- Use dot notation for nested CSV columns (e.g., by_package.pricing_model, totals.impressions)
- Simplify CSV section to focus on unnesting to by_package level
- Remove multi-level nesting references
- Update examples to match industry-standard dot notation format
…xamples

- Move Delivery Methods to parent section with Webhook-Based Reporting and Offline-File-Delivery-Based Reporting as subsections
- Move webhook-related sections (Privacy, Implementation Best Practices, Webhook Health Monitoring) under Webhook-Based Reporting
- Move Offline-File-Delivery-Based Reporting section before Data Reconciliation
- Add notification_type, sequence_number, and next_expected_at fields to all offline file format examples (JSONL, CSV, Parquet)
- Remove 'Recommended for most use cases' from JSONL section
- Update CSV format to use dot notation (by_package.pricing_model, totals.impressions)
@bokelley bokelley merged commit ead19fa into main Nov 18, 2025
5 checks passed
@bokelley bokelley deleted the restore-offline-file-delivery-section branch November 18, 2025 20:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants