Skip to content

docs(knowledge-graph): document Manual Declarations and the JSON import - #867

Draft
mangglesh wants to merge 1 commit into
mainfrom
docs/kg-manual-declarations
Draft

mangglesh wants to merge 1 commit into
mainfrom
docs/kg-manual-declarations

Conversation

@mangglesh

@mangglesh mangglesh commented Oct 7, 2026 •

Copy link
Copy Markdown
Contributor

Summary

Documents the Knowledge Graph's Manual Declarations: adding dependencies and resources the collectors cannot see, one at a time or from a single JSON document. The feature ships in nudgebee/nudgebee-enterprise#40384. That PR merges the old Manual Dependencies and Manual Nodes tabs into one, and replaces their two CSV imports with a single JSON import.

Stacked on #868. That PR turns the Knowledge Graph page into a section. This one adds a page to it. Merge #868 first; this PR then retargets to main on its own.

Merge this after nudgebee/nudgebee-enterprise#40384 is merged and released. Until then, these docs describe a tab that production doesn't have.

  • New page: Semantic Knowledge Graph → Manual Declarations. It covers:
    • what you can declare, and when a declared node merges with a collected one;
    • node and dependency statuses;
    • the JSON format, with field tables and an example;
    • what an import reports;
    • permissions and removal.
  • Links: the Overview, Where the Data Comes From, and How NudgeBee Uses the Graph pages now point to it.
  • API docs: kg_import_manual_dependencies is replaced by kg_create_manual_declarations, and the seven kg_*_manual_node* actions are added. The rows use the routing table's own descriptions, so the next regeneration produces the same text.

Type of change

  • New documentation page
  • Update to existing documentation

Checklist

  • I ran npm run build locally and the site builds without errors
  • I ran npm run lint locally and lint passes
  • Internal links work; new external links open the correct page
  • My commits are signed off (DCO — git commit -s)
  • I read CONTRIBUTING.md

Screenshots (if visual changes)

The four new images are in doc-server/docs/features/img/knowledge-graph-*.png, and the new page uses them. They show example names on a dev tenant, cropped to the dialog or section, with no endpoints or user names visible.

Additional notes

  • Release notes: this PR adds no release-notes or product-update entry. Those are written when the release that includes #40384 is cut.
  • API docs generator: the generator escapes only | and \ in action descriptions, so a { or < in a routing-table comment breaks the MDX build. The new action's comment originally contained one. It now sits in a code span, fixed at the source in #40384.

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request restructures the Semantic Knowledge Graph documentation by moving it into a dedicated directory and adding comprehensive documentation for the new Manual Declarations feature. It updates relative links across various files, introduces a new category configuration, and documents several new API actions for manual node and dependency management. Feedback on the changes includes a correction to use US English spelling ("favor" instead of "favour") in the API documentation description for kg_apply_manual_node_merge.

Comment thread doc-server/docs/api-docs/index.md
@mangglesh
mangglesh force-pushed the docs/kg-manual-declarations branch 2 times, most recently from 918609d to 58b01c8 Compare October 7, 2026 06:17
@blue4209211
blue4209211 marked this pull request as draft October 7, 2026 06:26
@mangglesh
mangglesh force-pushed the docs/kg-manual-declarations branch from 58b01c8 to e8cf3b0 Compare October 7, 2026 07:04
@mangglesh
mangglesh changed the base branch from main to docs/kg-feature-guide October 7, 2026 07:04
@mangglesh
mangglesh force-pushed the docs/kg-feature-guide branch from d4633a0 to 51dd16f Compare October 7, 2026 07:34
@mangglesh
mangglesh force-pushed the docs/kg-manual-declarations branch from e8cf3b0 to d068e7c Compare October 7, 2026 07:36
Base automatically changed from docs/kg-feature-guide to main October 7, 2026 07:40
@mangglesh
mangglesh force-pushed the docs/kg-manual-declarations branch from d068e7c to dea80e7 Compare October 7, 2026 09:57
Knowledge Graph Settings now has one Manual Declarations tab, and nodes
and dependencies are imported from a single JSON document instead of two
CSVs.

- New page features/knowledge-graph/manual-declarations: what can be
  declared and when a declared node merges with a collected one, node
  and dependency statuses, declaring one at a time, the JSON format
  with field tables and an example, import outcomes, permissions and
  removal.
- Link it from the Knowledge Graph overview, Where the Data Comes From,
  and How NudgeBee Uses the Graph.
- API docs: replace kg_import_manual_dependencies with
  kg_create_manual_declarations and add the kg_*_manual_node* actions
  that were never listed.

Co-Authored-By: Claude Opus 5.5 <[email protected]>
Signed-off-by: Mangglesh Dagar <[email protected]>
@mangglesh
mangglesh force-pushed the docs/kg-manual-declarations branch from dea80e7 to f326254 Compare October 8, 2026 05:51
@mangglesh
mangglesh marked this pull request as ready for review October 8, 2026 06:26
@mangglesh
mangglesh marked this pull request as draft October 8, 2026 06:27
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