From 1cab1b8ada0d101992eb7cfa22edcccfda26e8ab Mon Sep 17 00:00:00 2001 From: Syed Mohammed Sylani Date: Tue, 22 Jul 2025 12:49:59 +0530 Subject: [PATCH] docs: add Long description to cache main command Signed-off-by: Syed Mohammed Sylani --- docs/cli/gittuf_cache.md | 4 ++++ internal/cmd/cache/cache.go | 1 + 2 files changed, 5 insertions(+) diff --git a/docs/cli/gittuf_cache.md b/docs/cli/gittuf_cache.md index 04e241b1..dad5fc2a 100644 --- a/docs/cli/gittuf_cache.md +++ b/docs/cli/gittuf_cache.md @@ -2,6 +2,10 @@ Manage gittuf's caching functionality +### Synopsis + +The 'cache' command group contains subcommands to manage gittuf's local persistent cache. This cache helps improve performance by storing metadata locally. The cache is local-only and is not synchronized with remote repositories. + ### Options ``` diff --git a/internal/cmd/cache/cache.go b/internal/cmd/cache/cache.go index 2a7e8b2e..3eea4e38 100644 --- a/internal/cmd/cache/cache.go +++ b/internal/cmd/cache/cache.go @@ -13,6 +13,7 @@ func New() *cobra.Command { cmd := &cobra.Command{ Use: "cache", Short: "Manage gittuf's caching functionality", + Long: `The 'cache' command group contains subcommands to manage gittuf's local persistent cache. This cache helps improve performance by storing metadata locally. The cache is local-only and is not synchronized with remote repositories.`, DisableAutoGenTag: true, }