Skip to content

Add docs for chart bounded context#47877

Open
sgress454 wants to merge 3 commits into
mainfrom
sgress454/charts-docs
Open

Add docs for chart bounded context#47877
sgress454 wants to merge 3 commits into
mainfrom
sgress454/charts-docs

Conversation

@sgress454

Copy link
Copy Markdown
Contributor

Related issue: Resolves #47876

Adds internal documentation for the charts bounded context, including how to add new datasets and how to test. Usable by devs and LLMs.

@sgress454 sgress454 requested a review from a team as a code owner June 18, 2026 21:01
Copilot AI review requested due to automatic review settings June 18, 2026 21:01

@claude claude 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.

Claude Code Review

This repository is configured for manual code reviews. Comment @claude review to trigger a review and subscribe this PR to future pushes, or @claude review once for a one-time review.

Tip: disable this comment in your organization's Code Review settings.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Adds internal developer documentation for Fleet’s chart bounded context, describing its architecture, data model (SCD type-2 + bitmaps), how to add datasets, and how to test/seed chart data.

Changes:

  • Added comprehensive docs for server/chart/ (architecture, dependency rules, write/read paths, adding datasets, testing, dev tooling).
  • Added a server/chart/CLAUDE.md pointer/summary for quick orientation.
  • Updated tools/charts-collect/README.md to reference host_scd_data and the correct internal constants source file.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.

File Description
tools/charts-collect/README.md Updates collection docs to reflect current SCD table + internal constants reference.
server/chart/README.md New end-to-end bounded-context documentation (architecture, data model, extension + testing guidance).
server/chart/CLAUDE.md New quick “read this first” doc pointing to the main README and key gotchas.
Comments suppressed due to low confidence (1)

tools/charts-collect/README.md:13

  • This CVE description mentions closing the "prior-day" row and overwriting "today's" row, but the collector actually keys snapshot rows to hour boundaries (see bucketStart := time.Now().UTC().Truncate(time.Hour) in tools/charts-collect/main.go) and closes the prior open row at the current hour boundary. Updating this avoids misleading readers about the SCD semantics.
  bitmaps, and reconciles into `host_scd_data` (`dataset='cve'`). Unchanged
  CVEs keep their open row; changed bitmaps close the prior-day row and open
  a new one for today; intra-day changes overwrite today's row via ODKU.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread server/chart/README.md Outdated
Comment thread server/chart/README.md Outdated
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
@sgress454

Copy link
Copy Markdown
Contributor Author

@coderabbitai review

@coderabbitai

coderabbitai Bot commented Jun 18, 2026

Copy link
Copy Markdown
Contributor
✅ Action performed

Review finished.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@sgress454 sgress454 self-assigned this Jun 19, 2026
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.

Add docs for chart bounded context

2 participants