Move to Github Wiki Pages for Prompts
Closed this issue · 5 comments
Proposal to move prompt examples to Github wiki pages
Is your feature request related to a problem? Please describe.
As more and more prompt examples are added to the repository, the readme is becoming cluttered and difficult to navigate. There is also a limit to the amount of detail that can be included in the readme.
Describe the solution you'd like
I propose that we create a Github wiki page for each prompt category, such as "Bash Prompts" or "Python Prompts," and move all the prompt examples for that category to the corresponding wiki page. This would allow for more organized and detailed documentation of each prompt and would make it easier for contributors to add and maintain prompt examples.
Describe alternatives you've considered
One alternative would be to create separate markdown files for each prompt category, but this could become difficult to manage over time as the number of prompt categories grows. Another alternative would be to keep all prompt examples in the readme, but this would make the readme difficult to navigate and would limit the amount of detail that could be included.
It may be worthwhile to consider https://readthedocs.org/ for documentation. Especially if we're able to generate a bunch of the data documentation using the tool itself.
First page created: https://github.com/JohnnyIrvin/shell-craft/wiki/Home
Using Docker with shell craft https://github.com/JohnnyIrvin/shell-craft/wiki/Using-Docker-with-Shell-Craft
Using pip with shell craft https://github.com/JohnnyIrvin/shell-craft/wiki/Using-Shell-Craft-with-pip
Created https://github.com/JohnnyIrvin/shell-craft/wiki/Using-Different-Prompt-Options-with-Shell-Craft for different prompts options and examples.