docs icon indicating copy to clipboard operation
docs copied to clipboard

Update SB Aliases

Open Barrow1990 opened this issue 1 year ago • 8 comments

Update SB Aliases description under: https://docs.saltbox.dev/reference/guides/aliases/?h=

Current available options:

  • sb update
  • sb list
  • sb install
  • sb bench
  • sb recreate-venv
  • sb inventory
  • sb branch
  • sb sandbox-branch

Barrow1990 avatar Jan 07 '24 22:01 Barrow1990

@saltydk do you want all of these documented?

owine avatar Jan 07 '24 23:01 owine

I'm thinking we could use a page dedicated to sb, tags and roles since right now that info is scattered all over the docs. For instance, the new custom meta-tag stuff could be offloaded there rather than be footnotes on https://docs.saltbox.dev/saltbox/basics/install_types/. The inventory page might have less things to cover as a result and be more concise.

I can work on it if everyone's in agreement.

keldian avatar Feb 07 '24 09:02 keldian

Makes sense to me and timing is good with the new binary rewrite deployed

owine avatar Feb 07 '24 15:02 owine

Hi, Is there an update on this? Also do we know what sb sandbox-branch does and is this the best method for doing the following. Contributing to Sandbox Apps

Barrow1990 avatar Aug 15 '24 04:08 Barrow1990

branch commands are only useful for when users test something we don't think is ready for the main branch.

saltydk avatar Aug 15 '24 04:08 saltydk

Frankly, as far as I am concerned the sb tool describes what all commands do, if users need more they can ask on discord.

saltydk avatar Aug 15 '24 04:08 saltydk

That's fine. Should this issue be removed then?

Barrow1990 avatar Aug 15 '24 04:08 Barrow1990

Docs could just reference running

sb --help

since that will be the most up to date descriptions of all of the commands, if something is too vague then issue belongs in the sb repo.

saltydk avatar Aug 15 '24 04:08 saltydk