From d499b6e9d3333334614924669b74640a2d0b5485 Mon Sep 17 00:00:00 2001 From: zach valenta Date: Mon, 9 Dec 2024 07:00:04 -0500 Subject: [PATCH] fix typos in docs (#1266) Co-authored-by: zachvalenta --- doc/architecture.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/architecture.md b/doc/architecture.md index 395886ea964404e87944af00163d6c9e5e55ee59..e3a7f0b008c9cad15d7007bf873e8a9b13904856 100644 --- a/doc/architecture.md +++ b/doc/architecture.md @@ -1,6 +1,6 @@ # Internal architecture -This documentation only provide a bird-eye view of git-bug's internals. For more details, you should read the other documentations and the various comment/documentations scattered in the codebase. +This documentation only provides a bird's-eye view of git-bug's internals. For more details, you should read the other documentation and the various comment/documentation scattered in the codebase. ## Overview @@ -28,7 +28,7 @@ This documentation only provide a bird-eye view of git-bug's internals. For more Here is the internal architecture of git-bug. As you can see, it's a layered architecture. -As a general rule of thumbs, each layer use the directly underlying layer to access and interact with the data. As an example, the `commands` package will not directly use the `bug` or `repository` package. It will request the data from the `cache` layer and go from there. Of course, the `commands` package will ultimately use types defined in the lower level package like `Bug`, but retrieving and changing the data has to go through the `cache` layer to ensure that bugs are properly deduplicated in memory. +As a general rule of thumb, each layer uses the directly underlying layer to access and interact with the data. As an example, the `commands` package will not directly use the `bug` or `repository` package. It will request the data from the `cache` layer and go from there. Of course, the `commands` package will ultimately use types defined in the lower level package like `Bug`, but retrieving and changing the data has to go through the `cache` layer to ensure that bugs are properly deduplicated in memory. ## repository