docs: rewrite README as project landing page

No labels

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.

Dependencies

No dependencies set.

Reference

ldraney/pal-e-api#280

ldraney commented

2026-06-13 20:43:48 +00:00

Owner

Type

Feature

Lineage

Standalone — follows up on #278 docs restructuring. README has good technical content but doesn't communicate value proposition.

Repo

ldraney/pal-e-api

User Story

As a potential user evaluating pal-e-docs
I want a README that explains what makes it different
So that I understand why I'd use it over Notion + Jira + separate search

Context

The current README is a developer reference — endpoints, test commands, local setup. It doesn't explain the core architectural insight: knowledge, work state, and search are unified in one Postgres store with on-write embeddings and hybrid RRF search, queryable through 45+ MCP tools. For selling/demonstrating the project, the README needs to lead with the value prop.

File Targets

Files the agent should modify or create:

README.md -- rewrite as landing page

Files the agent should NOT touch:

docs/* -- technical deep-dives stay as-is
src/* -- no code changes

Feature Flag

none

Acceptance Criteria

README leads with unified-store insight
Explains on-write embedding pipeline, hybrid RRF search, boards-as-notes, MCP-native interface
Backs claims with real metrics from the codebase
Technical docs remain in docs/
Renders correctly on Forgejo

Test Expectations

Visual review: README renders correctly in Forgejo
Link check: docs/ links resolve
Run command: n/a (documentation only)

Constraints

All claims must be verified against actual codebase — no aspirational features
Internal Forgejo URLs removed from Related Repos (not useful to external viewers)

Checklist

PR opened
Tests pass
No unrelated changes

pal-e-docs -- project this affects

### Type Feature ### Lineage Standalone — follows up on #278 docs restructuring. README has good technical content but doesn't communicate value proposition. ### Repo `ldraney/pal-e-api` ### User Story As a potential user evaluating pal-e-docs I want a README that explains what makes it different So that I understand why I'd use it over Notion + Jira + separate search ### Context The current README is a developer reference — endpoints, test commands, local setup. It doesn't explain the core architectural insight: knowledge, work state, and search are unified in one Postgres store with on-write embeddings and hybrid RRF search, queryable through 45+ MCP tools. For selling/demonstrating the project, the README needs to lead with the value prop. ### File Targets Files the agent should modify or create: - `README.md` -- rewrite as landing page Files the agent should NOT touch: - `docs/*` -- technical deep-dives stay as-is - `src/*` -- no code changes ### Feature Flag none ### Acceptance Criteria - [ ] README leads with unified-store insight - [ ] Explains on-write embedding pipeline, hybrid RRF search, boards-as-notes, MCP-native interface - [ ] Backs claims with real metrics from the codebase - [ ] Technical docs remain in docs/ - [ ] Renders correctly on Forgejo ### Test Expectations - [ ] Visual review: README renders correctly in Forgejo - [ ] Link check: docs/ links resolve - Run command: n/a (documentation only) ### Constraints - All claims must be verified against actual codebase — no aspirational features - Internal Forgejo URLs removed from Related Repos (not useful to external viewers) ### Checklist - [ ] PR opened - [ ] Tests pass - [ ] No unrelated changes ### Related - `pal-e-docs` -- project this affects

ldraney referenced this issue from a pull request that will close it,

2026-06-13 20:44:06 +00:00

docs: rewrite README as project landing page #281

ldraney referenced this issue

2026-06-13 20:46:36 +00:00

ldraney closed this issue

2026-06-13 21:41:40 +00:00