De-duplicate event-sourcing-api.md by removing self-concatenated content

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.

Blocks

#30 Epic: Clean up event sourcing documentation

aethyr/Aethyr

Reference: aethyr/Aethyr#65

freemo commented

2026-03-14 23:57:25 +00:00

Owner

Metadata

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

Background and Context

docs/developer/event-sourcing-api.md (2194 lines) is literally concatenated with itself. Lines ~947-2194 repeat the same content from lines 1-946. This duplication inflates the document and confuses readers.

Expected Behavior

The document is approximately 1100 lines with no repeated sections. The remaining content is reviewed for accuracy and the document builds correctly.

Acceptance Criteria

Duplicated second half (lines ~947-2194) removed
Remaining content reviewed for accuracy
Builds correctly with bundle exec rake documentation

Subtasks

Code: Identify and remove duplicated sections in docs/developer/event-sourcing-api.md
Docs: Review remaining content for accuracy and consistency
Tests (Cucumber): Add tests/unit/docs_es_api_dedup.feature covering document structure validation and duplicate detection.
Tests (Cucumber Integration): Add integration feature in tests/integration/ for event-sourcing-api 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-api.md` - **Branch**: `feature/m3-docs-es-cleanup` ## Background and Context `docs/developer/event-sourcing-api.md` (2194 lines) is literally concatenated with itself. Lines ~947-2194 repeat the same content from lines 1-946. This duplication inflates the document and confuses readers. ## Expected Behavior The document is approximately 1100 lines with no repeated sections. The remaining content is reviewed for accuracy and the document builds correctly. ## Acceptance Criteria - [ ] Duplicated second half (lines ~947-2194) removed - [ ] Remaining content reviewed for accuracy - [ ] Builds correctly with `bundle exec rake documentation` ## Subtasks - [ ] Code: Identify and remove duplicated sections in `docs/developer/event-sourcing-api.md` - [ ] Docs: Review remaining content for accuracy and consistency - [ ] Tests (Cucumber): Add `tests/unit/docs_es_api_dedup.feature` covering document structure validation and duplicate detection. - [ ] Tests (Cucumber Integration): Add integration feature in `tests/integration/` for event-sourcing-api 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

freemo added the

State/Verified

Priority/Medium

Type/Task

labels

freemo added a new dependency

2026-03-14 23:59:00 +00:00

freemo self-assigned this

2026-03-15 04:25:23 +00:00

MoSCoW/Must Have

Points/2