Skip to content

chore: readme update - #1424

Merged
dhfang merged 2 commits into
chore/retire-link-namefrom
docs-readme-monorepo
Aug 26, 2026
Merged

chore: readme update#1424
dhfang merged 2 commits into
chore/retire-link-namefrom
docs-readme-monorepo

Conversation

@dhfang

@dhfang dhfang commented Aug 26, 2026

Copy link
Copy Markdown
Contributor

Updates the repo readme to reflect the presence of new monorepo components

closes FOU-1222

@dhfang
dhfang requested a review from a team as a code owner August 26, 2026 02:46
@greptile-apps

greptile-apps Bot commented Aug 26, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

Updates the repository README to reflect the expanded monorepo structure and improve documentation discovery.

  • Revises the project title and synopsis.
  • Adds a repository-layout table covering specifications, CLI, documentation, tests, protobufs, generated code, examples, and scripts.
  • Adds direct links to introductory, architecture, and CLI documentation.

Confidence Score: 5/5

The documentation-only change appears safe to merge.

The updated component descriptions are consistent with their repository contents, all referenced paths exist, and no blocking or independently actionable issue remains.

Important Files Changed

Filename Overview
README.md The revised repository overview, component descriptions, and documentation links align with the current tree; all relative links resolve.

Reviews (1): Last reviewed commit: "reword the repository layout and documen..." | Re-trigger Greptile

@linear-code

linear-code Bot commented Aug 26, 2026

Copy link
Copy Markdown

FOU-1222

@dhfang
dhfang force-pushed the docs-readme-monorepo branch from adc9cc8 to b718b9f Compare August 26, 2026 03:03
@dhfang
dhfang force-pushed the docs-readme-monorepo branch from b718b9f to f105066 Compare August 26, 2026 03:13
@dhfang
dhfang force-pushed the docs-readme-monorepo branch from f105066 to 48459b2 Compare August 26, 2026 03:29
@dhfang
dhfang force-pushed the docs-readme-monorepo branch from 48459b2 to 38aee75 Compare August 26, 2026 03:31
@dhfang
dhfang force-pushed the docs-readme-monorepo branch from 38aee75 to 73b2a1b Compare August 26, 2026 03:38
dhfang added 2 commits August 26, 2026 09:36
…lementations

Signed-off-by: Dennis Fang <dhsfang@gmail.com>
Signed-off-by: Dennis Fang <dhsfang@gmail.com>
@dhfang
dhfang force-pushed the docs-readme-monorepo branch from 73b2a1b to 6204e28 Compare August 26, 2026 16:36
@dhfang
dhfang merged commit f98258a into main Aug 26, 2026
21 checks passed
@dhfang
dhfang deleted the docs-readme-monorepo branch August 26, 2026 17:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants