update-readme

Prompt file imported from decaf-ts/decaf-ts.github.io (.codex/prompts/update-readme.md). Copyright stays with the author.

the user need to give a <base_path> representing where to run commands on, and where to consider the root folder. escaping this root folder for anything must be granted explicit permission by the user.

task 1 - read all files under <base_path>/src/**/*.ts and store them in . task 2 - understand the content of each file, the repository as a whole. Identify main Classes, Functions, and overall functionality task 3 - read all files under <base_path>/tests/**/*.ts and store them in . task 4 - understand the content of each test file, and how to use the main objects of the repository and what for. task 5 - from the identified elements, elaborate a short summary of the intent of the library and write in <base_path>/workdocs/1-Header.md under the banner and title task 6 - from the identified elements, elaborate a detailed description of the intent of the library and write in <base_path>workdocs/4-Description.md under the title

• write examples in the workdocs/5-HowToUse.md file for all the identified elements
• each example MUST contain:
  • Description of the use case;
  • typescript example using the appropriate typescript code notation in md format stop only when the task is done task 4 - read the file <base_path>/.codex/prompts/doc.md and .<base_path>/.codex/prompts/module.md for instructions on how to document the module file. task 5 - for each of the remaining files in , read the file <base_path>/.codex/prompts/doc.md and ./.codex/prompts/file.md for instructions on how to document that file. Use the module name created in task 4 for eventual @memberOf reference. task 6 - build the docs by running in <base_path> the command npm run docs. If it fails iterate fixing it until it passes

NOTES:

• when documenting a function type as a parameter, ALWAYS use the function(type1,type2):return_type syntax