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.
Introduces a new package as my proposed solution for syncing TS docs with developer docs. The workflow would be as follows:
@telnyx/webrtc
is published@telnyx/webrtc-api-docs
package, sync npm version to@telnyx/webrtc
version@telnyx/webrtc-api-docs
to react-developer-docsThis seems like a sane way to keep versions in sync, instead of storing API versions or even content in another platform like Contentful. You would only need to upgrade the
@telnyx/webrtc-api-docs
dependency in dev docs and rebuild to get the latest version.Follow up work to consume JSON would be done in react-developer-docs.
📝 To Do
✋ Manual testing
npm install
inpackages/js
if you haven't done so alreadynpm run docs
inpackages/api-docs
. Verify that JSON output inpackages/api-docs/lib
looks as expected: