helpers icon indicating copy to clipboard operation
helpers copied to clipboard

Doc and blog about bash_print_tree

Open aangelo9 opened this issue 6 months ago • 1 comments

Specs

  • We want to write a how to guide for bash_print_tree() from helpers/lib_tasks_bash.py

  • We want to explain the flow of creating a tree, adding comments, then updating the tree since the dir have changed, etc.

  • Doc should be placed under docs/tools/all.invoke_bash_print_tree.how_to_guide.md

  • Documentation Markdown should include:

    • Comprehensive explanation of the goal of the invoke
    • Description of its behavior and instructions on how to use it
    • Limitations, ways to develop further in the future
  • The output documentation should be

    • ready to be published as a blog entry on our Ghost platform (see https://ghost.org/help/using-markdown/)
    • included in our dev_system white paper

FYI @gpsaggese

aangelo9 avatar Jun 16 '25 16:06 aangelo9