Repository navigation
docs(knowledge-graph): document the Knowledge Graph end to end - #868
Conversation
There was a problem hiding this comment.
Code Review
This pull request restructures the 'Semantic Knowledge Graph' documentation by moving it from a single flat file into a dedicated directory with multiple sub-pages (Overview, Exploring, Nodes and Relationships, Data Sources, and How NudgeBee Uses the Graph) and a category configuration. It also updates all referencing links across the documentation and adds custom CSS to style nested sidebar items. The reviewer feedback consistently identifies spelling inconsistencies, specifically pointing out several instances of British English spellings (such as 'Organisations', 'Centre', 'neighbours', 'summarises', 'neighbourhood', 'organised', 'organisation', and 'greyed') that should be updated to US English to maintain consistency throughout the documentation.
The Knowledge Graph page covered only the canvas basics, and some of it was out of date (a 2,000-node limit that is 1,500, animated edges that are plain arrows, a legend behind an info icon that is the Relationships button). It said nothing about where the data comes from, how fresh it is, the full set of types, or where NudgeBee uses the graph. The page becomes a section, Features → Semantic Knowledge Graph, at the same URL: - Overview: what the graph is, where to open it, what is in it, how fresh it is, and who can see it. - Explore the Graph: every filter, search and focus, clicking through, Path and Back/Forward, the canvas controls, the 1,500-node limit and the empty states. - Nodes and Relationships: reading a node, node and edge details, type and sub-type, and reference tables for every node and relationship type the graph produces. - Where the Data Comes From: each inventory and flow source and what it needs, cross-source links, the operator-enabled flow sources, freshness and removal timing, and the Coverage settings. - How NudgeBee Uses the Graph: NuBi's dependency answers, alert impact and grouping, blast radius on recommendations, service criticality. The section opens by default, and nested sidebar sections now use the same case as the pages beside them; only top-level groups stay in capitals. Links to the old page path are updated. Co-Authored-By: Claude Opus 5.5 <[email protected]> Signed-off-by: Mangglesh Dagar <[email protected]>
51dd16f
d4633a0 to
51dd16f
Compare
Summary
The Knowledge Graph had one page, which covered only the canvas basics and was out of date in places:
It said nothing about where the data comes from, how fresh it is, the full set of node and relationship types, or where NudgeBee uses the graph. This PR turns the page into a section, Features → Semantic Knowledge Graph, at the same URL:
The section opens by default. Nested sidebar sections now use the same case as the pages beside them, and only top-level groups stay in capitals; this applies across the site.
Everything here describes what is shipped on
maintoday. Manual Declarations (#867) will stack on top of this PR.Type of change
Checklist
npm run buildlocally and the site builds without errorsnpm run lintlocally and lint passesgit commit -s)Additional notes
mainsource, about 230 claims in all, and the 31 errors that pass found are fixed.