Skip to content

chore: New docs generation#68

Merged
monoxgas merged 6 commits into
mainfrom
fix/new-docs-generation
Jun 8, 2025
Merged

chore: New docs generation#68
monoxgas merged 6 commits into
mainfrom
fix/new-docs-generation

Conversation

@monoxgas
Copy link
Copy Markdown
Contributor

@monoxgas monoxgas commented Jun 8, 2025

  • Refactored auto-docs generation and integrations
  • Cleaned up various code for pre-commit hooks behaviors

Generated Summary:

  • Renamed the existing GitHub workflow from docs.yaml to docs-update.yaml to better reflect its purpose.
  • Updated trigger paths for the documentation update event:
    • Removed scripts/make_docs.py
    • Added .hooks/generate_docs.py and .github/workflows/docs-update.yaml
  • Enhanced client payload in the documentation update job to:
    • Change docs_dir from docs to source_dir
    • Introduce target_dir and nav_target for better context in payload data.
  • Introduced a new hook at .hooks/generate_docs.py:
    • Implements automated documentation generation for MDX files.
    • Provides custom Markdown conversion with special handling for code blocks and details.
  • Created a new pre-commit hook to refresh dependencies on post-merge events.
  • Added a new pre-push hook for typing and linting checks using Poetry.
  • Document structure in docs.json has been significantly revised for better organization and styling:
    • New schema integration with Mintlify and updated theming.
    • Structured navigation groups for clearer user guidance.
  • A set of asset images added to the documentation.

These changes improve the clarity and functionality of the documentation workflow, enhance coding standards with automated checks, and refine the user experience with improved documentation structure.

This summary was generated with ❤️ by rigging

@dreadnode-renovate-bot dreadnode-renovate-bot Bot added area/docs Changes to documentation and guides area/python Changes to Python package configuration and dependencies area/pre-commit Changes made to pre-commit hooks area/examples Changes to example code and demonstrations area/github Changes made to GitHub Actions type/core Changes to core repository files and configurations type/docs Documentation updates and improvements labels Jun 8, 2025
@monoxgas monoxgas merged commit 242b228 into main Jun 8, 2025
8 checks passed
@monoxgas monoxgas deleted the fix/new-docs-generation branch June 8, 2025 00:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/docs Changes to documentation and guides area/examples Changes to example code and demonstrations area/github Changes made to GitHub Actions area/pre-commit Changes made to pre-commit hooks area/python Changes to Python package configuration and dependencies type/core Changes to core repository files and configurations type/docs Documentation updates and improvements

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant