fix: resolve docs generation failures - #3
Merged
Conversation
- Fix nursery-api overlay: target parent objects instead of scalar paths (overlay update values must be objects/arrays, not strings) - Remove orphaned '- api: API Reference' from stress-test product that referenced the old fern/definition/ without a generators.yml Co-Authored-By: Sandeep Dinesh <sandeep@buildwithfern.com>
Contributor
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
|
🌿 Preview your docs: https://fern-preview-da896d0b-8585-4b6e-b03e-5ffc35ce5fc5.docs.buildwithfern.com |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fixes the failing
publish-docsCI workflow (run #10) caused by two issues:Nursery API overlay invalid format: The overlay targeted scalar paths (
$.paths./bulk/plants.get.description) with string values, but the OpenAPI Overlay spec requiresupdatevalues to be objects or arrays. Fixed by targeting the parent object and providing the description as a property.Orphaned API Reference in stress-test product: The
- api: API Referenceentry referenced the oldfern/definition/directory which has nogenerators.yml. In the multi-API structure (withfern/apis/), this causes "Failed to load API Definition" errors. Removed the orphaned entry since API definitions are properly configured in the Garden and Nursery products.Review & Testing Checklist for Human
fern generate --docspasses in CI (the publish-docs workflow should succeed when this merges)/bulk/plantsand/suppliersendpointsNotes
Verified locally that
fern generate --docs --previewsucceeds and publishes all 1022 pages across 5 API workspaces.Link to Devin session: https://app.devin.ai/sessions/14236bb1544445d58ab2e9a9971af688
Requested by: @thesandlord