doc: fix typo & add syntaxic coloration for yaml
All checks were successful
continuous-integration/drone/push Build is passing

This commit is contained in:
Glenn Y. Rolland 2024-01-03 17:53:01 +01:00
parent 3244130a51
commit 29cf12f8cd

View file

@ -26,7 +26,7 @@ ChatGPT.
## Limitations ## Limitations
**Note:** Note: This tool is optimized for smaller codebases. For larger **Note:** This tool is optimized for smaller codebases. For larger
repositories, performance may not be optimal due to processing constraints and repositories, performance may not be optimal due to processing constraints and
the nature of interactions with ChatGPT. the nature of interactions with ChatGPT.
@ -120,9 +120,8 @@ result file itself:
You can also do the same by storing all parameters within a configuration file You can also do the same by storing all parameters within a configuration file
(ex: `code_preloader.yml`). (ex: `code_preloader.yml`).
``` ```yaml
--- ---
ignore_list: ignore_list:
- .git - .git
- .code_preloader.yml - .code_preloader.yml
@ -130,9 +129,7 @@ ignore_list:
- prompts - prompts
output_file_path: result.txt output_file_path: result.txt
header_prompt_file_path: prompts/header-context.txt header_prompt_file_path: prompts/header-context.txt
footer_prompt_file_path: prompts/footer-write-readme.txt footer_prompt_file_path: prompts/footer-write-readme.txt
``` ```