Skip to content

feat: Add ops endpoints and refactor sync workflow#284

Merged
dohernandez merged 91 commits intomainfrom
feat/nod-369-document-ops-rpc-endpoint
Aug 26, 2025
Merged

feat: Add ops endpoints and refactor sync workflow#284
dohernandez merged 91 commits intomainfrom
feat/nod-369-document-ops-rpc-endpoint

Conversation

@dohernandez
Copy link
Copy Markdown
Member

@dohernandez dohernandez commented Aug 21, 2025

Description

This PR implements support for ops API endpoints following the established pattern of GenLayer Methods and Debug Methods, and comprehensively refactors the GitHub sync workflow for better maintainability. The ops endpoints are integrated into the documentation generation system with proper navigation and template support. Additionally, the monolithic 904-line sync workflow has been refactored into a modular 6-job architecture with extracted utilities and centralized configuration.

Motivation and Context

The documentation needed support for ops endpoints to provide complete API coverage. The existing GitHub workflow was difficult to maintain due to code duplication and monolithic structure. This refactoring maintains 100% functional equivalence while significantly improving code organization and maintainability.

Changes Made

Ops Endpoint Support:

  • Added ops directory structure and navigation (_meta.json files)
  • Extended API documentation generation to support ops methods
  • Updated template system with content.mdx for dynamic generation
  • Modified generate-api-docs.js to handle ops endpoints

Workflow Architecture:

  • Refactored sync workflow from 1 monolithic job to 6 modular jobs
  • Extracted 8 reusable shell scripts for common operations
  • Added centralized configuration (sync-config.yml)
  • Created sync-files composite action
  • Implemented matrix strategy for parallel operations
  • Added proper artifact-based result aggregation

Types of Changes

  • New feature (non-breaking change that adds functionality)
  • Bug fix (non-breaking change that fixes an issue)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Chore (maintenance tasks, refactoring, or non-functional changes like updating dependencies or improving documentation)

Testing

No test files were modified in this PR. The changes maintain existing functionality while improving architecture. The workflow refactoring preserves all original behavior including regex patterns, config sanitization, and PR templates.

Checklist

  • My code follows the code style of this project
  • I have added the necessary documentation (if appropriate)
  • I have added tests (if appropriate)
  • Lint and unit tests pass locally with my changes

Impact

  • Documentation: Ops endpoints now follow the same structure as GenLayer/Debug methods
  • Workflow: 59% reduction in main workflow lines (904→366) while maintaining identical functionality
  • Maintainability: Modular architecture with reusable components and centralized configuration
  • Performance: Parallel sync operations through matrix strategy

Summary by CodeRabbit

  • New Features

    • Added a “Sync Files” GitHub Action to automate file/directory syncing with filters and change metrics.
    • Introduced a version-driven, multi-stage workflow to sync sources, aggregate results, generate docs, and create/update PRs with summaries.
  • Documentation

    • Added a templated GenLayer Node API reference page with sections for Gen, Debug, and new Ops methods.
    • Minor formatting improvements in existing API reference pages.
    • Updated navigation to include Ops Methods.
  • Chores

    • Added helper scripts for version detection, report aggregation, doc generation, config sanitization, and artifact syncing.
    • Example trigger updated and artifact cleanup enabled.

Loading
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.

2 participants