plugin-tools icon indicating copy to clipboard operation
plugin-tools copied to clipboard

Docs: Update the "Prompts" page

Open leventebalogh opened this issue 1 year ago • 1 comments

What changed?

The following titles in the left sidebar are a bit confusing (similar titles referring to different things):

  • Reference
    • CLI commands (available NPM scripts for development)
    • Prompts (prompts for the create-plugin command)

This PR mostly

  • Removes the docs for the NPM scripts (I think this is kind of unnecessary)
  • What's currently "Prompts" becomes "CLI commands"
  • Moves the update command docs from "Migration" to "Reference > CLI commands"

leventebalogh avatar Aug 08 '24 05:08 leventebalogh

Hello! 👋 This repository uses Auto for releasing packages using PR labels.

✨ This PR can be merged. It will not be considered when calculating future versions of the npm packages and will not appear in the changelogs.

github-actions[bot] avatar Aug 08 '24 05:08 github-actions[bot]

@leventebalogh documenting all the CLIs available for a tool is pretty customary, whether it's in a markdown or in a "help" command available from the tool itself. i'm not sure it's necessary to remove the existing list of commands, but let's do it if there's a general feeling that it's information overload.

josmperez avatar Aug 19 '24 21:08 josmperez

I know this PR is merged, but I just want to say I appreciate your contribution to these docs. Thanks!

josmperez avatar Sep 05 '24 20:09 josmperez