feat: add gRPC API Reference example#13
Merged
Merged
Conversation
Co-Authored-By: Devin Logan <devinannlogan@gmail.com>
Contributor
Author
🤖 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 Here are the markdown pages you've updated: |
Co-Authored-By: Devin Logan <devinannlogan@gmail.com>
devalog
approved these changes
May 28, 2026
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
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
Adds a new
grpc/example demonstrating how to generate gRPC API Reference documentation from Protocol Buffer (.proto) files. Follows the same structure as the existinggraphql/example with a plant-themed Plant Store gRPC service.New files:
grpc/fern/proto/plantstore/v1/plantstore.proto— service with unary and server-streaming RPCs, enums, and messagesgrpc/fern/generators.yml— points to the proto filegrpc/fern/docs.yml— navigation with Docs + API Reference tabs,flattened: trueto reduce sidebar nestinggrpc/fern/docs/pages/welcome.mdx— landing pagegrpc/fern/docs/pages/api-reference-overview.mdx— overview with card linksUpdated files:
README.md— added grpc row to examples table.github/workflows/check.yml— addedgrpcto CI matrix.github/workflows/preview-docs.yml— addedgrpcto preview project list.github/workflows/publish-docs.yml— addedgrpcto publish matrixReview & Testing Checklist for Human
fern checkpasses for the grpc example (CI runs this)Notes
buf) is needed in CIflattened: trueto the API reference section in docs.yml to reduce sidebar nestingLink to Devin session: https://app.devin.ai/sessions/32ed4c2e39a641468652a38f58330896
Requested by: @devalog