Write substantive index.md landing page

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

#29 Epic: Complete placeholder documentation pages

aethyr/Aethyr

Reference: aethyr/Aethyr#62

freemo commented

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

Owner

Metadata

Commit Message: docs(site): write substantive index.md landing page
Branch: feature/m3-docs-landing

Background and Context

docs/index.md currently contains only 14 lines of generic welcome text. The documentation landing page should serve as the primary entry point for new users and contributors, providing a clear introduction to the project and guiding them to relevant sections.

Expected Behavior

A substantive landing page at docs/index.md with a project introduction, key feature highlights, a quick-start guide, and navigation links to all major documentation sections. The page builds correctly with bundle exec rake documentation.

Acceptance Criteria

Quick-start section with 3-step guide (install, setup, connect)
Feature highlights covering 5-6 key capabilities
Navigation links to all major documentation sections
Builds correctly with bundle exec rake documentation

Subtasks

Docs: Write content for docs/index.md with project introduction, key features, getting started links
Tests (Cucumber): Add tests/unit/docs_landing.feature covering landing page content validation.
Tests (Cucumber Integration): Add integration feature in tests/integration/ for documentation build verification.
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): write substantive index.md landing page` - **Branch**: `feature/m3-docs-landing` ## Background and Context `docs/index.md` currently contains only 14 lines of generic welcome text. The documentation landing page should serve as the primary entry point for new users and contributors, providing a clear introduction to the project and guiding them to relevant sections. ## Expected Behavior A substantive landing page at `docs/index.md` with a project introduction, key feature highlights, a quick-start guide, and navigation links to all major documentation sections. The page builds correctly with `bundle exec rake documentation`. ## Acceptance Criteria - [ ] Quick-start section with 3-step guide (install, setup, connect) - [ ] Feature highlights covering 5-6 key capabilities - [ ] Navigation links to all major documentation sections - [ ] Builds correctly with `bundle exec rake documentation` ## Subtasks - [ ] Docs: Write content for `docs/index.md` with project introduction, key features, getting started links - [ ] Tests (Cucumber): Add `tests/unit/docs_landing.feature` covering landing page content validation. - [ ] Tests (Cucumber Integration): Add integration feature in `tests/integration/` for documentation build verification. - [ ] 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/3