Skip to content

Conversation

@fentas
Copy link
Owner

@fentas fentas commented Aug 8, 2025

This pull request updates the documentation for all b CLI subcommands to provide clearer, more concise, and consistent usage instructions. The changes improve discoverability, clarify flag usage, and streamline examples across all command docs. The most important changes are grouped below by theme:

General Documentation Improvements:

  • Updated command descriptions and usage sections for all subcommands (completion, init, install, list, request, search, update) to be more concise and user-focused. [1] [2] [3] [4] [5] [6] [7]

Command-Specific Enhancements:

  • Added or improved examples for each command, showing typical usage scenarios and flag combinations, including output formatting and configuration options. [1] [2] [3] [4] [5] [6] [7]
  • Updated installation and configuration instructions for shell completions, including recommendations for bash-completion and Oh My Zsh. [1] [2]

Flags and Options Standardization:

  • Standardized flag tables and descriptions for each command, clearly separating command-specific flags from global flags. [1] [2] [3] [4] [5] [6]
  • Added details on output formatting flags (e.g., --output json|yaml) for list and search commands. [1] [2]

Aliases and Command Discovery:

  • Documented command aliases (e.g., ls, l for list; s for search; u for update) to improve discoverability and usability. [1] [2] [3]

Removal of Redundant and Outdated Content:

  • Removed repetitive, outdated, or overly verbose sections, such as detailed error handling, best practices, and project structure explanations, to keep docs focused and actionable. [1] [2] [3] [4] [5] [6] [7]

@fentas fentas merged commit 1f5e2cd into main Aug 8, 2025
8 checks passed
@fentas fentas deleted the vibe/docs-restructure branch August 8, 2025 08:45
fentas added a commit that referenced this pull request Aug 19, 2025
…ing (#62)

This pull request updates the documentation for all `b` CLI subcommands
to provide clearer, more concise, and consistent usage instructions. The
changes improve discoverability, clarify flag usage, and streamline
examples across all command docs. The most important changes are grouped
below by theme:

**General Documentation Improvements:**

* Updated command descriptions and usage sections for all subcommands
(`completion`, `init`, `install`, `list`, `request`, `search`, `update`)
to be more concise and user-focused.
[[1]](diffhunk://#diff-29c69644505c19112463df5a106ef6097b0b0a3b3524d9e2148cc46c7b11c068L2-R33)
[[2]](diffhunk://#diff-2f2c3e601a9646bde58b6f591216f29228070f85349080986d1f75af9806bcffL2-R48)
[[3]](diffhunk://#diff-ace06bf2653260d72e0a9a495792b277d33a14c2c7935fd391e201f233f1f75eL2-R72)
[[4]](diffhunk://#diff-2eee9d920bc319bf63623b4ffe4142ad3124a6142b22a7adb8ac0e9a54232b55L2-R63)
[[5]](diffhunk://#diff-0296c06c7b87fae3b9d776f805943a2636730f67d9c99fec18db07190f698a5bL2-R46)
[[6]](diffhunk://#diff-bbae3b1db827d55c30b2c6869917c8ef78aa8a1480884da4495ebf31735ef6b8L2-R59)
[[7]](diffhunk://#diff-646eb0ad1719fec2f250a9fc7fe632f0cee5d76b378b2dc885b49c157f208621L2-R58)

**Command-Specific Enhancements:**

* Added or improved examples for each command, showing typical usage
scenarios and flag combinations, including output formatting and
configuration options.
[[1]](diffhunk://#diff-29c69644505c19112463df5a106ef6097b0b0a3b3524d9e2148cc46c7b11c068L77-R99)
[[2]](diffhunk://#diff-2f2c3e601a9646bde58b6f591216f29228070f85349080986d1f75af9806bcffL2-R48)
[[3]](diffhunk://#diff-ace06bf2653260d72e0a9a495792b277d33a14c2c7935fd391e201f233f1f75eL2-R72)
[[4]](diffhunk://#diff-2eee9d920bc319bf63623b4ffe4142ad3124a6142b22a7adb8ac0e9a54232b55L2-R63)
[[5]](diffhunk://#diff-0296c06c7b87fae3b9d776f805943a2636730f67d9c99fec18db07190f698a5bL2-R46)
[[6]](diffhunk://#diff-bbae3b1db827d55c30b2c6869917c8ef78aa8a1480884da4495ebf31735ef6b8L2-R59)
[[7]](diffhunk://#diff-646eb0ad1719fec2f250a9fc7fe632f0cee5d76b378b2dc885b49c157f208621L2-R58)
* Updated installation and configuration instructions for shell
completions, including recommendations for bash-completion and Oh My
Zsh.
[[1]](diffhunk://#diff-29c69644505c19112463df5a106ef6097b0b0a3b3524d9e2148cc46c7b11c068R43-R52)
[[2]](diffhunk://#diff-29c69644505c19112463df5a106ef6097b0b0a3b3524d9e2148cc46c7b11c068R64-R65)

**Flags and Options Standardization:**

* Standardized flag tables and descriptions for each command, clearly
separating command-specific flags from global flags.
[[1]](diffhunk://#diff-2f2c3e601a9646bde58b6f591216f29228070f85349080986d1f75af9806bcffL2-R48)
[[2]](diffhunk://#diff-ace06bf2653260d72e0a9a495792b277d33a14c2c7935fd391e201f233f1f75eL2-R72)
[[3]](diffhunk://#diff-2eee9d920bc319bf63623b4ffe4142ad3124a6142b22a7adb8ac0e9a54232b55L2-R63)
[[4]](diffhunk://#diff-0296c06c7b87fae3b9d776f805943a2636730f67d9c99fec18db07190f698a5bL2-R46)
[[5]](diffhunk://#diff-bbae3b1db827d55c30b2c6869917c8ef78aa8a1480884da4495ebf31735ef6b8L2-R59)
[[6]](diffhunk://#diff-646eb0ad1719fec2f250a9fc7fe632f0cee5d76b378b2dc885b49c157f208621L2-R58)
* Added details on output formatting flags (e.g., `--output json|yaml`)
for `list` and `search` commands.
[[1]](diffhunk://#diff-2eee9d920bc319bf63623b4ffe4142ad3124a6142b22a7adb8ac0e9a54232b55L2-R63)
[[2]](diffhunk://#diff-bbae3b1db827d55c30b2c6869917c8ef78aa8a1480884da4495ebf31735ef6b8L2-R59)

**Aliases and Command Discovery:**

* Documented command aliases (e.g., `ls`, `l` for `list`; `s` for
`search`; `u` for `update`) to improve discoverability and usability.
[[1]](diffhunk://#diff-2eee9d920bc319bf63623b4ffe4142ad3124a6142b22a7adb8ac0e9a54232b55L2-R63)
[[2]](diffhunk://#diff-bbae3b1db827d55c30b2c6869917c8ef78aa8a1480884da4495ebf31735ef6b8L2-R59)
[[3]](diffhunk://#diff-646eb0ad1719fec2f250a9fc7fe632f0cee5d76b378b2dc885b49c157f208621L2-R58)

**Removal of Redundant and Outdated Content:**

* Removed repetitive, outdated, or overly verbose sections, such as
detailed error handling, best practices, and project structure
explanations, to keep docs focused and actionable.
[[1]](diffhunk://#diff-29c69644505c19112463df5a106ef6097b0b0a3b3524d9e2148cc46c7b11c068L104-L129)
[[2]](diffhunk://#diff-2f2c3e601a9646bde58b6f591216f29228070f85349080986d1f75af9806bcffL2-R48)
[[3]](diffhunk://#diff-ace06bf2653260d72e0a9a495792b277d33a14c2c7935fd391e201f233f1f75eL2-R72)
[[4]](diffhunk://#diff-2eee9d920bc319bf63623b4ffe4142ad3124a6142b22a7adb8ac0e9a54232b55L2-R63)
[[5]](diffhunk://#diff-0296c06c7b87fae3b9d776f805943a2636730f67d9c99fec18db07190f698a5bL2-R46)
[[6]](diffhunk://#diff-bbae3b1db827d55c30b2c6869917c8ef78aa8a1480884da4495ebf31735ef6b8L2-R59)
[[7]](diffhunk://#diff-646eb0ad1719fec2f250a9fc7fe632f0cee5d76b378b2dc885b49c157f208621L2-R58)
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.

2 participants