De-duplicate event-sourcing.md and immudb-integration.md #66

Open
opened 2026-03-14 23:57:26 +00:00 by freemo · 0 comments
Owner

Metadata

  • Commit Message: docs(site): de-duplicate event sourcing docs
  • Branch: feature/m3-docs-es-cleanup

Background and Context

event-sourcing.md duplicates its own sections after line 378. immudb-integration.md has 3 copies of the "Why ImmuDB?" section. Additionally, there is overlapping content between docs/developer/event-sourcing-api.md and event_sourcing_documentation.md that should be cross-referenced rather than duplicated.

Expected Behavior

Both event-sourcing.md and immudb-integration.md have no internal self-duplication. Overlapping content between event sourcing documents is replaced with cross-references. All documents build correctly.

Acceptance Criteria

  • event-sourcing.md: repeated sections after line ~378 removed
  • immudb-integration.md: 2 redundant "Why ImmuDB?" copies removed
  • Cross-references added between overlapping event sourcing documents
  • All affected documents build correctly with bundle exec rake documentation

Subtasks

  • Code: Compare docs/developer/event-sourcing-api.md with event_sourcing_documentation.md, remove overlapping content, add cross-references
  • Code: Edit docs/server/event-sourcing.md to remove repeated sections after line ~378
  • Code: Edit docs/server/immudb-integration.md to remove 2 redundant "Why ImmuDB?" copies
  • Docs: Add cross-references between related event sourcing documents
  • Tests (Cucumber): Add tests/unit/docs_es_dedup.feature covering document deduplication validation.
  • Tests (Cucumber Integration): Add integration feature in tests/integration/ for event sourcing documentation build.
  • Tests (Profiling): Run bundle exec rake unit_profile and verify no performance regressions for documentation generation.
  • Quality: Verify coverage >=85% via bundle exec rake unit. If coverage is <85% then review the current unit test coverage report at build/tests/unit/coverage/ and use it to write new Cucumber based unit tests to improve code coverage. Specifically, write Cucumber/Gherkin style unit tests that are descriptively named and specifically improve coverage on whichever file has the most uncovered lines by writing tests that will target the uncovered lines in the report. Once that is done rerun bundle exec rake unit to verify all tests pass and coverage is above >=85%. Only mark this as complete once coverage is >=85%, if not repeat this task as many times as is needed until coverage reaches >=85%.
  • Quality: Run bundle exec rake (default task: unit tests with coverage) and bundle exec rake integration, fix any errors if needed ensuring both pass across entire code base, do not ignore any failure even if it seems unrelated to this commit, fix it.

Definition of Done

This issue is complete when:

  • All subtasks above are completed and checked off.
  • A Git commit is created where the first line of the commit message matches the Commit Message in Metadata exactly, followed by a blank line, then additional lines providing relevant details about the implementation.
  • The commit is pushed to the remote on the branch matching the Branch in Metadata exactly.
  • The commit is submitted as a pull request to master, reviewed, and merged before this issue is marked done.
## Metadata - **Commit Message**: `docs(site): de-duplicate event sourcing docs` - **Branch**: `feature/m3-docs-es-cleanup` ## Background and Context `event-sourcing.md` duplicates its own sections after line 378. `immudb-integration.md` has 3 copies of the "Why ImmuDB?" section. Additionally, there is overlapping content between `docs/developer/event-sourcing-api.md` and `event_sourcing_documentation.md` that should be cross-referenced rather than duplicated. ## Expected Behavior Both `event-sourcing.md` and `immudb-integration.md` have no internal self-duplication. Overlapping content between event sourcing documents is replaced with cross-references. All documents build correctly. ## Acceptance Criteria - [ ] `event-sourcing.md`: repeated sections after line ~378 removed - [ ] `immudb-integration.md`: 2 redundant "Why ImmuDB?" copies removed - [ ] Cross-references added between overlapping event sourcing documents - [ ] All affected documents build correctly with `bundle exec rake documentation` ## Subtasks - [ ] Code: Compare `docs/developer/event-sourcing-api.md` with `event_sourcing_documentation.md`, remove overlapping content, add cross-references - [ ] Code: Edit `docs/server/event-sourcing.md` to remove repeated sections after line ~378 - [ ] Code: Edit `docs/server/immudb-integration.md` to remove 2 redundant "Why ImmuDB?" copies - [ ] Docs: Add cross-references between related event sourcing documents - [ ] Tests (Cucumber): Add `tests/unit/docs_es_dedup.feature` covering document deduplication validation. - [ ] Tests (Cucumber Integration): Add integration feature in `tests/integration/` for event sourcing documentation build. - [ ] Tests (Profiling): Run `bundle exec rake unit_profile` and verify no performance regressions for documentation generation. - [ ] Quality: Verify coverage >=85% via `bundle exec rake unit`. If coverage is <85% then review the current unit test coverage report at `build/tests/unit/coverage/` and use it to write new Cucumber based unit tests to improve code coverage. Specifically, write Cucumber/Gherkin style unit tests that are descriptively named and specifically improve coverage on whichever file has the most uncovered lines by writing tests that will target the uncovered lines in the report. Once that is done rerun `bundle exec rake unit` to verify all tests pass and coverage is above >=85%. Only mark this as complete once coverage is >=85%, if not repeat this task as many times as is needed until coverage reaches >=85%. - [ ] Quality: Run `bundle exec rake` (default task: unit tests with coverage) and `bundle exec rake integration`, fix any errors if needed ensuring both pass across **entire** code base, do not ignore any failure even if it seems unrelated to this commit, fix it. ## Definition of Done This issue is complete when: - All subtasks above are completed and checked off. - A Git commit is created where the **first line** of the commit message matches the Commit Message in Metadata exactly, followed by a blank line, then additional lines providing relevant details about the implementation. - The commit is pushed to the remote on the branch matching the **Branch** in Metadata exactly. - The commit is submitted as a **pull request** to `master`, reviewed, and **merged** before this issue is marked done.
freemo added this to the v1.1.0 milestone 2026-03-14 23:57:26 +00:00
freemo self-assigned this 2026-03-15 04:25:23 +00:00
freemo modified the milestone from v1.1.0 to v1.2.0 2026-03-16 00:28:12 +00:00
Sign in to join this conversation.
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Reference: aethyr/Aethyr#66
No description provided.