feat: sync from docs, add service.yaml config reference coverage (powersync-docs #578) - #98
Merged
Merged
Conversation
…sync-docs #578) Documents heartbeat_interval_seconds, snapshot_socket_timeout, prometheus_port, healthcheck probes, migrations, object storage, storage_version, and fixes the broken Configuration File Structure link. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_011tbVhPt9P57RheBsAqtfc5
michaelbarnes
approved these changes
Sep 8, 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
2 participants
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.
Source docs PR: powersync-ja/powersync-docs#578
Release impact:
feat:, adds new tag entries and new content sections covering recently documented service.yaml options; tag changes require a minor release to reach existing installs.What changed in docs
PR #578 added a full
service.yamlconfiguration reference to the Self-Hosted Instance Configuration page, documenting many previously undocumented config options and correcting a structural issue in the skeleton config (thetelemetrykey was incorrectly indented underclient_auth).Skill updates in this PR
skills/powersync/references/powersync-service.md: Fixed the broken "Configuration File Structure" resource link (the anchor no longer exists after the docs rewrite). Updated theclient_authdocs link anchor from#client-authenticationto#client_auth. Added a new "Additional service.yaml Options" subsection coveringtelemetry.prometheus_port,healthcheck.probes,migrations.disable_auto_migration,heartbeat_interval_seconds(all source types, since Service v1.24.0),snapshot_socket_timeout(Postgres, since Service v1.26.0),storage.object_storage(MongoDB S3 offload, experimental, since Service v1.24.0),storage.default_storage_version(since Service v1.26.0), and thesync_rulesdeprecated alias. Updatedmetadata.tagsto add terms for these new options.Notes for reviewer
telemetrytop-level position clarification matters: the old docs skeleton showedtelemetryindented insideclient_auth, which was invalid nesting. An agent following that example would generate a broken config. The new note makes the correct position explicit.storage.object_storagerequiresstorage_version: 3in the sync config; this is noted inline in the new section.prometheus_portandsnapshot_socket_timeoutwere already mentioned in the Kubernetes section of the skill. The new subsection makes them discoverable via tags and documents them for non-Kubernetes deployments as well.powersync-service.mdscope.https://claude.ai/code/session_011tbVhPt9P57RheBsAqtfc5
Generated by Claude Code