Polish README.md for portfolio-facing presentation

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

forgejo_admin/pal-e-api#243

forgejo_admin commented

2026-03-28 22:08:00 +00:00

Owner

Type

enhancement

Lineage

Standalone — no parent epic.

Repo

forgejo_admin/pal-e-api

User Story

As a recruiter or engineer reviewing this repo, I want a clear, professional README so I can quickly understand what the project does, its tech stack, and its scope.

Context

The current README is internal-facing and references outdated architecture (SQLite instead of PostgreSQL, old data model). It needs to be rewritten as a polished portfolio-ready document that leads with what the platform does and highlights the engineering quality (685+ tests, 47 endpoints, semantic search, block-first content model).

File Targets

README.md

Acceptance Criteria

README leads with a clear title and one-liner describing the platform
Tech stack section covers FastAPI, SQLAlchemy, Alembic, PostgreSQL/CNPG, pgvector
Key features highlighted: block content model, kanban boards, Forgejo sync, semantic search, MCP integration
API surface summarized (47 endpoints, 8 route modules)
Repo structure overview included
Related repos linked
No internal operational details (deployment URLs, cluster specifics)

Test Expectations

No test changes — documentation only.

Constraints

Keep concise — lead with what it does, not how it is built
No internal URLs or secrets
Professional tone suitable for external review

Checklist

README.md rewritten
No broken markdown
Reviewed for accuracy against codebase

None

### Type enhancement ### Lineage Standalone — no parent epic. ### Repo forgejo_admin/pal-e-api ### User Story As a recruiter or engineer reviewing this repo, I want a clear, professional README so I can quickly understand what the project does, its tech stack, and its scope. ### Context The current README is internal-facing and references outdated architecture (SQLite instead of PostgreSQL, old data model). It needs to be rewritten as a polished portfolio-ready document that leads with what the platform does and highlights the engineering quality (685+ tests, 47 endpoints, semantic search, block-first content model). ### File Targets - `README.md` ### Acceptance Criteria - [ ] README leads with a clear title and one-liner describing the platform - [ ] Tech stack section covers FastAPI, SQLAlchemy, Alembic, PostgreSQL/CNPG, pgvector - [ ] Key features highlighted: block content model, kanban boards, Forgejo sync, semantic search, MCP integration - [ ] API surface summarized (47 endpoints, 8 route modules) - [ ] Repo structure overview included - [ ] Related repos linked - [ ] No internal operational details (deployment URLs, cluster specifics) ### Test Expectations No test changes — documentation only. ### Constraints - Keep concise — lead with what it does, not how it is built - No internal URLs or secrets - Professional tone suitable for external review ### Checklist - [ ] README.md rewritten - [ ] No broken markdown - [ ] Reviewed for accuracy against codebase ### Related None

forgejo_admin referenced this issue from a commit

2026-03-28 22:09:05 +00:00

docs: rewrite README as portfolio-facing project overview

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

2026-03-28 22:09:24 +00:00

docs: rewrite README as portfolio-facing project overview #244

forgejo_admin

2026-03-28 22:10:39 +00:00