thuanle/claw-email
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: reorganize README and technical overview #23

Merged
thuanle merged 1 commits from docs/readme-docs-reorg into main 2026-04-29 00:52:42 +07:00
Conversation 0 Commits 1 Files Changed 2
+130 -53
codex commented 2026-04-29 00:50:38 +07:00
Collaborator
Copy Link
Copy Source

Summary

  • refocus README.md on onboarding, quickstart, runtime config, and health checks
  • add docs/architecture/overview.md as the current technical reference for flow, package layout, state machine, and major technology choices
  • move deeper technical detail out of the landing page and link README to architecture and ADR docs

Changes

  • remove package tree, pipeline state machine, and dependency table from README.md
  • keep .env reference and operational entrypoints in README.md
  • add architecture overview with links to relevant ADRs and historical design spec

Test Plan

  • go test ./...
  • git diff --check -- README.md docs/architecture/overview.md
  • test -f docs/architecture/overview.md && test -f docs/adr/README.md
  • rg -n 'docs/architecture/overview.md|docs/adr/README.md' README.md
  • rg -n '^## (Kiến trúc|Pipeline trạng thái|Công nghệ)$' README.md

Refactor

  • none

Docs/ADR

  • added docs/architecture/overview.md
  • updated README.md to point to architecture and ADR docs
  • no ADR needed because this change reorganizes documentation without changing runtime behavior or repository policy

Risks/Follow-ups

  • if docs/architecture/overview.md grows substantially, it can be split into smaller architecture docs later
## Summary - refocus `README.md` on onboarding, quickstart, runtime config, and health checks - add `docs/architecture/overview.md` as the current technical reference for flow, package layout, state machine, and major technology choices - move deeper technical detail out of the landing page and link README to architecture and ADR docs ## Changes - remove package tree, pipeline state machine, and dependency table from `README.md` - keep `.env` reference and operational entrypoints in `README.md` - add architecture overview with links to relevant ADRs and historical design spec ## Test Plan - `go test ./...` - `git diff --check -- README.md docs/architecture/overview.md` - `test -f docs/architecture/overview.md && test -f docs/adr/README.md` - `rg -n 'docs/architecture/overview.md|docs/adr/README.md' README.md` - `rg -n '^## (Kiến trúc|Pipeline trạng thái|Công nghệ)$' README.md` ## Refactor - none ## Docs/ADR - added `docs/architecture/overview.md` - updated `README.md` to point to architecture and ADR docs - no ADR needed because this change reorganizes documentation without changing runtime behavior or repository policy ## Risks/Follow-ups - if `docs/architecture/overview.md` grows substantially, it can be split into smaller architecture docs later
codex added 1 commit 2026-04-29 00:50:39 +07:00
docs: reorganize readme and architecture docs
CI / staticcheck (pull_request) Successful in 1m39s
Details
CI / fmt (pull_request) Successful in 5s
Details
CI / test (pull_request) Successful in 1m27s
Details
CI / vet (pull_request) Successful in 57s
Details
a499841b1e
thuanle closed this pull request 2026-04-29 00:52:31 +07:00
thuanle reopened this pull request 2026-04-29 00:52:35 +07:00
thuanle merged commit 376057361f into main 2026-04-29 00:52:42 +07:00
thuanle deleted branch docs/readme-docs-reorg 2026-04-29 00:52:42 +07:00
Sign in to join this conversation.
Reviewers
No Reviewers
Labels
No items
No labels
Milestone
No items
No Milestone
Projects
Clear projects
No projects
Assignees
Clear assignees
claudecode codex opencode thuanle
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: thuanle/claw-email#23