Skip to content

docs: polish sharing and release readiness#136

Open
ayagmar wants to merge 1 commit into
masterfrom
refactor/split-event-store
Open

docs: polish sharing and release readiness#136
ayagmar wants to merge 1 commit into
masterfrom
refactor/split-event-store

Conversation

@ayagmar

@ayagmar ayagmar commented Jul 17, 2026

Copy link
Copy Markdown
Owner

Summary

  • add README share-card gallery and privacy guidance
  • document the split event-store internals
  • add production release checklist and LinkedIn post draft

Validation

  • pnpm run verify:ci
  • 155 test files / 1,377 tests passed
  • coverage: 96.09% statements, 90.24% branches
  • site check and build passed

No release or publication was performed.

Summary by CodeRabbit

  • Documentation
    • Added guidance for creating and reviewing shareable SVG snapshots containing aggregated metrics only.
    • Added example commands and preview images for monthly usage and trend reports.
    • Added a production release checklist covering verification, packaging, security, and deployment steps.
    • Added a LinkedIn launch post draft and contributor documentation links.
    • Clarified the event store architecture and stable persistence interface.

@github-actions

Copy link
Copy Markdown
Contributor

Dependency Review

✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.

Scanned Files

None

@coderabbitai

coderabbitai Bot commented Jul 17, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

Documentation updates add shareable snapshot guidance and launch materials, define a production release checklist, and clarify the event-store module architecture and public persistence boundary.

Changes

Shareable snapshots and launch materials

Layer / File(s) Summary
Shareable snapshot documentation and messaging
README.md, site/src/content/docs/output-formats.mdx, docs/marketing/linkedin-post.md, docs/README.md
Documents deterministic offline SVG snapshots, aggregated-only content, generation examples, repository previews, launch messaging, and public-sharing review guidance.

Production release process

Layer / File(s) Summary
Production release checklist
docs/release-checklist.md
Defines pre-release checks, the verification gate, package and publishing safety requirements, and post-approval release verification.

Event-store architecture documentation

Layer / File(s) Summary
Event-store module map and architecture
docs/architecture.md, site/src/content/docs/architecture/event-store.mdx
Clarifies the public event-store.ts facade and the responsibilities of the schema, database, codec, administration, and history modules.

Estimated code review effort: 1 (Trivial) | ~5 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title is concise and accurately reflects the documentation-focused changes around sharing and release readiness.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch refactor/split-event-store

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

ESLint install timed out. The project may have too many dependencies for the sandbox.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@codecov

codecov Bot commented Jul 17, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

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

🧹 Nitpick comments (1)
docs/marketing/linkedin-post.md (1)

29-29: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick win

Suppress MD018 for the intentional hashtag line.

#AI is valid LinkedIn hashtag content, not a Markdown heading. Add a scoped markdownlint suppression rather than inserting a space and changing the post’s meaning.

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/marketing/linkedin-post.md` at line 29, Add a scoped markdownlint MD018
suppression for the intentional hashtag line in the LinkedIn post, preserving
the existing hashtag text exactly and limiting the suppression to that line.

Source: Linters/SAST tools

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Nitpick comments:
In `@docs/marketing/linkedin-post.md`:
- Line 29: Add a scoped markdownlint MD018 suppression for the intentional
hashtag line in the LinkedIn post, preserving the existing hashtag text exactly
and limiting the suppression to that line.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 3ffd0385-5a23-447b-b15c-bac7c9de3094

📥 Commits

Reviewing files that changed from the base of the PR and between cbfe83a and fb53549.

📒 Files selected for processing (7)
  • README.md
  • docs/README.md
  • docs/architecture.md
  • docs/marketing/linkedin-post.md
  • docs/release-checklist.md
  • site/src/content/docs/architecture/event-store.mdx
  • site/src/content/docs/output-formats.mdx

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.

1 participant