Comments (4)
I think the best solution right now is to make sure there are comments directly in the proto file and then we can link to that file in Github. I created a Notion page to collect the comments.
from documentation.
Just an update here -
I tried to use Snipsync here as a quick win.
However, proto file linters don't like comments at the end of the files:
temporalio/api#108
So, options are:
- Find a way to add an exception to the linter to work with Snipsync
- Alter Snipsync such that it only needs an opening wrapper somehow
- Just link directly to that file from the docs and add informational comments inline to the file (need to do this to use Snipsync anyways)
- Duplicate the list and document the events in another file somewhere
from documentation.
i think for our purposes we can just do 3 or 4 for now, and if we figure out how to do 1 or 2 in future we can double back
from documentation.
Done!
#296
from documentation.
Related Issues (20)
- core-2.4.0.tgz: 2 vulnerabilities (highest severity is: 7.5) - autoclosed HOT 1
- calendar option for creating schedule throws error
- [ Bug report ] Link in docs to https://docs.temporal.io/workflows#queries does not find the anchor
- [ Bug report ] Accessibility issue: Diagrams in docs have small, often-unreadable text
- Go Worker versioning app dev guide content HOT 2
- [ Documentation request ] Slack Link No Longer Valid
- [ Documentation request ] Move Temporal CLI installation instructions under `/cli` HOT 1
- [ Documentation request ] Add "polyglot" usage to dev guide HOT 1
- Typo in Getting Started Documentation
- [ Documentation request ] A warning block on storing state for dev server
- [ Documentation request ] TypeScript Foundations: incorrect worker start samples
- [ Documentation request ] /references/web-ui-environment-variables `TEMPORAL_PUBLIC_PATH` should be `TEMPORAL_UI_PUBLIC_PATH`
- [ Documentation request ] workflow.Go() / Multi-threading documentation
- [ Documentation request ] TEMPORAL_CSRF_COOKIE_INSECURE
- [ Documentation request ] Example of Go heartbeat listening with test suite
- [ Documentation request ] Example of single activity testing in Go
- [Support] Add or update grpc headers HOT 32
- webpack-font-preload-plugin-1.5.0.tgz: 1 vulnerabilities (highest severity is: 5.3) - autoclosed HOT 1
- temporalio-1.6.0.tgz: 1 vulnerabilities (highest severity is: 5.5) - autoclosed HOT 1
- [ Documentation request ] Remove workflow_type label from some workflow_task metrics
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 documentation.