Comments (2)
viktorklang
commented on July 29, 2024
3
After thinking about this topic for a bit, I propose that we formalize the specification within the proto files as documentation, that way the protocol and its specification lives side-by-side and deviation from the specification should be less frequent as changes in the protocol would mean updating the documentation. Thoughts?
from cloudstate.
viktorklang
commented on July 29, 2024
Looks like it is an option to use this plugin to then export the specification from the proto files to publishable documents: https://github.com/pseudomuto/protoc-gen-doc
from cloudstate.
Related Issues (20)
- TCK: order of state action updates for addItem by the value entity ShoppingCart HOT 4
- Empty streamed responses are not actually connected HOT 2
- Dead letter logs on CRDT entity passivation HOT 1
- Failure: multiple grpc services in the same package HOT 1
- Projections for value entities
- HTTP API default mappings HOT 1
- Docker build error for Dockerfile.js-shopping-cart HOT 3
- Documentation on How to get started is not complete
- How / when are new versions of cloudstate-proxy-dev-mode published HOT 5
- Upgrade to akka-persistence-spanner 1.0.0-RC5 HOT 16
- Add local cache images layer for docker images on build HOT 5
- [proto] having gRPC service names PascalCase'd and others. HOT 1
- Usability issue with CRUD entity naming HOT 9
- Native-image Cassandra smoke test is flaky HOT 2
- nil pointer exception in spanner_store.go
- K8s Resource limits not applied to user functions HOT 2
- Additional conditions not managed properly when reconciling StatefulService
- NPM module postinstall fails on Windows
- A proposal to find and agree on a common protocol to discover services HOT 5
- The wrong site HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from cloudstate.