Skip to content

docs(core): document PropertyGraphConfig in configs reference - #2420

Merged
rafal-hawrylak merged 1 commit into
mainfrom
docs/property-graph-configs-reference
Nov 6, 2026
Merged

rafal-hawrylak merged 1 commit into
mainfrom
docs/property-graph-configs-reference

Conversation

@rafal-hawrylak

@rafal-hawrylak rafal-hawrylak commented Nov 4, 2026 •

Copy link
Copy Markdown
Collaborator

Summary

Documents the property_graph_config.proto configuration messages (PropertyGraphConfig, SemanticModelConfig, GraphDeploymentConfig, GraphDimensionConfig, GraphEntityConfig, GraphRelationshipConfig, GraphFieldConfig, GraphMetricConfig, GraphAiContextConfig, GraphUniqueKeyList, and DataSourceRef) in docs/reference/configs.md and syncs the proto comments in protos/property_graph_config.proto and protos/configs.proto.

Changes

  • docs/reference/configs.md:
    • Adds property_graph_config.proto and its message links to the Table of Contents.
    • Adds propertyGraph to the ActionConfig field table (noting that it is configured via definitions/**/graph.yaml, not actions.yaml).
    • Adds protocol reference tables and HTML anchors (#dataform-PropertyGraphConfig, etc.) matching the documentation URLs emitted by verifyObjectMatchesProto on definitions/**/graph.yaml schema validation errors.
  • protos/property_graph_config.proto & protos/configs.proto:
    • Syncs message and field comments with docs/reference/configs.md so future scripts/regenerate_docs runs preserve the descriptions.
  • scripts/regenerate_docs:
    • Includes property_graph_config.proto alongside configs.proto in the protobuf doc generation command.

@rafal-hawrylak
rafal-hawrylak requested a review from a team as a code owner November 4, 2026 16:26
@rafal-hawrylak
rafal-hawrylak requested review from Ford544, apilaskowski, mbiernacik and zaptot and removed request for a team and zaptot November 4, 2026 16:26
Comment thread docs/reference/configs.md Resolved
Comment thread docs/reference/configs.md Resolved
@rafal-hawrylak
rafal-hawrylak force-pushed the docs/property-graph-configs-reference branch from a26899f to 5037675 Compare November 6, 2026 06:57
@rafal-hawrylak
rafal-hawrylak merged commit c846912 into main Nov 6, 2026
15 checks passed
@rafal-hawrylak
rafal-hawrylak deleted the docs/property-graph-configs-reference branch November 6, 2026 07:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants