chore: Docs and Repo updates

[monoxgas]

Notes

• Refactored auto docs generation and repo notification syncing
• Cleaned up all pre-commit behaviors

---

Generated Summary

Summary of changes made in this PR:

• Improved contributor documentation and templates:

  • Updated .github/CODE_OF_CONDUCT.md for consistency in language and inclusiveness.
  • Minor formatting fixes in the PULL_REQUEST_TEMPLATE.md.

• CI/CD process enhancements:

  • Refactored .github/workflows/ci.yml to streamline the workflow configuration by removing extraneous whitespace.
  • Added a new workflow .github/workflows/docs-update.yaml for triggering updates to documentation when relevant files change.
  • Created a new Semantic PRs checker in .github/workflows/semantic-prs.yaml to enforce the format of PR titles.
  • Introduced Semgrep analysis in .github/workflows/semgrep.yaml for code quality checks during PRs.

• Linter integrations and configuration:

  • Introduced .hooks/linters/yamllint.yaml for YAML linting rules.
  • Added pre-commit hooks in .pre-commit-config.yaml for various checks, including large files and JSON/YAML validation.

• Added script and hooks for dependency management and pre-completion tweaks:

  • New .hooks/check_pinned_hash_dependencies.py script checks for unpinned dependencies in GitHub Actions.
  • Added .hooks/post_merge.sh to run poetry install if dependencies changed post-merge.

• Enhanced code documentation:

  • Significant updates to API documentation files in /docs/api for various modules including chat, completion, data, error, generator, and interact, providing better clarity on usage and configuration.

• Various minor bug fixes and content adjustments across multiple source files to ensure functional integrity and documentation accuracy.

The updates improve both the usability and maintainability of the codebase, as well as enhance the developer experience with better tools for collaboration (PR templates, code linting) and documentation consistency.

This summary was generated with ❤️ by rigging

Generated Summary

• Updated the .github/CODE_OF_CONDUCT.md for consistency in formatting.
• Refined the CI workflow definitions in .github/workflows/ci.yml:
  • Corrected formatting of branch names to remove spaces.
  • Moved the setup of Python version to the appropriate section and enabled caching using Poetry for faster dependency installation.
• Introduced new GitHub Actions workflows:
  • .github/workflows/docs-update.yaml to automatically notify updates to documentation on main.
  • .github/workflows/semantic-prs.yaml to enforce semantic PR title checks.
  • .github/workflows/semgrep.yaml for code analysis on codebase.
  • .github/workflows/template-sync.yaml for synchronizing infrastructure files with template updates.
• Added post-merge and prettier hooks in .hooks/ directory for better code standards.
• Enhanced the generate_docs.py script to streamline documentation generation.
• Introduced a new Python script .hooks/check_pinned_hash_dependencies.py to ensure that GitHub Actions are using pinned dependencies.
• Added a new base file for .github/scripts/generate_pr_description.py script which was renamed for better organization.
• Updated README.md to correct a typo.
• Introduced several new API documentation files for better project structure and enhanced documentation clarity.
• Added utility functions for handling chat interactions and logging in the rigging package to improve maintainability and functionality.

This summary was generated with ❤️ by rigging

[Copilot]

Pull Request Overview

This PR updates documentation and repository configurations while refactoring auto-doc generation and pre-commit behaviors. Key changes include:

• New and updated MDX documentation for API functions (parsing, logging, interact, error handling).
• Improvements to pre-commit hook configurations and helper scripts.
• Enhancements to GitHub workflow definitions and minor README fixes.

Reviewed Changes

Copilot reviewed 61 out of 61 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
docs/api/parsing.mdx	Added detailed documentation for parsing functions
docs/api/logging.mdx	Introduced docs for logging configuration
docs/api/interact.mdx	Provided documentation for interactive chat session functionality
docs/api/error.mdx	Documented custom error classes and their usage
README.md	Corrected a spelling mistake in the description
.secrets.baseline	Added secrets configuration baseline
.pre-commit-config.yaml	Updated pre-commit hooks and their configurations
.hooks/prettier.sh	Introduced a helper script for Prettier formatting
.hooks/post_merge.sh	Added post-merge script to update dependencies
.hooks/generate_docs.py	Implemented auto-doc generation script
.hooks/check_pinned_hash_dependencies.py	Included check for GitHub Actions dependency pinning
.github/workflows/*	Modified workflow definitions for CI, docs-update, publish, and PR update
.github/CODE_OF_CONDUCT.md	Made minor improvements to language consistency