Skip to content

Conversation

@damilola-paystack
Copy link
Member


name: Developer Experience Improvement
about: Restructure codebase for better experience when working with the specification files


Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update

What issue does this change solve?

This PR introduces an updated structure and tooling to improve developer experience.

Additional context

We now use Redocly to split/bundle OAS and Scalar to view spec locally.

@tolu-paystack
Copy link
Contributor

Hey @damilola-paystack, finally got around to reviewing this. I love the setup for previewing locally 🔥

I noticed that the sample responses use the schema and not actual examples. Do you know how we fix that?
Screenshot 2025-09-04 at 12 46 46

Also, what is the ideal flow for contributing now that we can split and bundle the file? Do I make my changes on the split files, bundle, then submit a PR?

Copy link
Contributor

@tolu-paystack tolu-paystack left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 🚀

@damilola-paystack damilola-paystack merged commit 1ae7fef into main Sep 8, 2025
2 checks passed
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.

3 participants