Added codebase direction guide

[ErisDS]

Summary

• document Ghost's current codebase priorities, active migrations, explorations, and planned changes in one public guide
• clarify the guidance contributors should follow when choosing React, TypeScript, ESM, Zod, data-access, dependency, and statelessness patterns
• record the public Ghost 7.0 timeframe and planned compatibility removals

Testing

• pnpm exec oxfmt --check docs/codebase/direction.md
• pnpm exec markdownlint-cli2 --config .markdownlint-cli2.jsonc docs/codebase/direction.md
• pnpm exec remark --use remark-validate-links --frail --quiet --no-stdout docs/codebase/direction.md
• git diff --check

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: QUIET

Plan: Essentials

Run ID: f3e0a2f2-471e-4567-a943-ab930a3dc0fe

📥 Commits

Reviewing files that changed from the base of the PR and between 3181372 and 1977779.

📒 Files selected for processing (1)

• docs/codebase/direction.md

Included review availability: Your plan provides up to 10 included reviews per hour; 1 remains after this review.

📜 Recent review details

⏰ Context from checks skipped due to timeout. (1)

• GitHub Check: Setup

🧰 Additional context used

📓 Path-based instructions (2)

Check technical claims, paths, commands, and declared authority/status against the current repository.

⚙️ CodeRabbit configuration file

Files:

• docs/codebase/direction.md

Prioritise concrete correctness, security, data-integrity, compatibility, and regression risks.

⚙️ CodeRabbit configuration file

Files:

• docs/codebase/direction.md

🧠 Learnings (1)

📓 Common learnings

Learnt from: CR
Repo: TryGhost/Ghost

Timestamp: 2026-09-04T11:43:20.358Z
Learning: Always use `pnpm`, never npm or Yarn.

🔇 Additional comments (1)

docs/codebase/direction.md (1)

1-194: LGTM!

---

Walkthrough

Added docs/codebase/direction.md with migration priorities, architectural guidance, compatibility transitions, and transitional-code practices. Added links to the guide in AGENTS.md and docs/README.md.

Merge Risk: ⚪ Minimal · up to 19777

This adds and links contributor direction documentation without changing runtime behavior or public APIs. No current merge-readiness risk remains.

🚥 Pre-merge checks | ✅ 6

✅ Passed checks (6 passed)

Check name	Status	Explanation
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Type-Safe Boundaries	✅ Passed	PASS: The PR changes only AGENTS.md, docs/README.md, and adds the prose-only docs/codebase/direction.md. It introduces no runtime boundary consumer, schemas, type declarations, any bypass, unc…
New Files Are Typescript	✅ Passed	The pull request adds only docs/codebase/direction.md. It modifies AGENTS.md and docs/README.md. No new .js, .jsx, .cjs, or .mjs source file appears in the diff.
Title check	✅ Passed	The title clearly and concisely describes the primary change: adding a codebase direction guide.
Description check	✅ Passed	The description directly explains the new guide, its documented priorities, contributor guidance, planned changes, and validation performed.

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch codex/codebase-direction-docs

---

_{Comment @coderabbitai help to get the list of available commands.}

[nx-cloud]

View your CI Pipeline Execution ↗ for commit 3181372

---

☁️ Nx Cloud last updated this comment at 2026-09-04 11:46:08 UTC