summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBertrand Yuan <me@bertyuan.com>2026-03-18 13:15:58 +0800
committerBertrand Yuan <me@bertyuan.com>2026-03-18 13:24:37 +0800
commit9291b688916f446b5515d910cadbaf813c8ffea3 (patch)
treed442b158154d045688f8cd3bfbba281f6d2ce6fa
parent67a63aa84b5d3815c0917d0e292ef422637c5217 (diff)
chore(style): use tree structure
Use a tree structure for the project layout in the README to improve readability.
-rw-r--r--README43
1 files changed, 22 insertions, 21 deletions
diff --git a/README b/README
index 9c76834..3023339 100644
--- a/README
+++ b/README
@@ -87,31 +87,32 @@ Project structure (excerpt)
---------------------------
src/
- app/
- (main)/(home)/page.tsx Home with hero, recent posts, CTA
- (main)/(home)/posts/[slug]/page.tsx Post detail with comments and share
- (main)/(home)/posts/page.tsx Paginated posts list
- (main)/(home)/tags/page.tsx Tag hub
- (main)/api/search/route.ts Search index API
- (main)/rss.xml/route.ts Atom/RSS feed
- (payload)/admin/... Payload CMS admin
- lib/ Data and utilities (payload-posts,
- metadata, auth-client)
- server/ better-auth and Drizzle schema plus
- comment storage
- emails/ React Email templates
+├── app/
+│ ├── (main)/(home)/page.tsx Home with hero, recent posts, CTA
+│ ├── (main)/(home)/posts/[slug]/page.tsx Post detail with comments and share
+│ ├── (main)/(home)/posts/page.tsx Paginated posts list
+│ ├── (main)/(home)/tags/page.tsx Tag hub
+│ ├── (main)/api/search/route.ts Search index API
+│ ├── (main)/rss.xml/route.ts Atom/RSS feed
+│ └── (payload)/admin/... Payload CMS admin
+├── lib/ Data and utilities (payload-posts,
+│ metadata, auth-client)
+├── server/ better-auth and Drizzle schema plus
+│ comment storage
+└── emails/ React Email templates
Routes and APIs
---------------
-/ Home with hero, latest posts, and CTA.
-/posts Paginated posts; /posts/[slug] for detail with rich text,
- comments, and share.
-/tags Tag cloud with counts.
-/login Google or GitHub login entry.
-/admin Payload CMS admin.
-/api/search Search index endpoint (fumadocs search).
-/rss.xml Atom/RSS feed.
+/ Home with hero, latest posts, and CTA.
+├── posts Paginated posts; /posts/[slug] for detail with rich text,
+│ comments, and share.
+├── tags Tag cloud with counts.
+├── login Google or GitHub login entry.
+├── admin Payload CMS admin.
+├── api/
+│ └── search Search index endpoint (fumadocs search).
+└── rss.xml Atom/RSS feed.
Developer notes
---------------