If we use Github's API to traverse the project structure of a public repo, one of the things that we get back are absolute paths to each file in the repo as strings. Given a list of these file path strings, we need to generate Markdown with a "tree printout," similar to that of the tree command.
If we recognize the name and placement of a particular directory, we should include a comment about what that directory is for in this printout. For instance, if we find a src/ directory at the root of the repo, we should include a statement about how source files live there, as opposed to other types of files in the repo.
If we use Github's API to traverse the project structure of a public repo, one of the things that we get back are absolute paths to each file in the repo as strings. Given a list of these file path strings, we need to generate Markdown with a "tree printout," similar to that of the tree command.
If we recognize the name and placement of a particular directory, we should include a comment about what that directory is for in this printout. For instance, if we find a
src/
directory at the root of the repo, we should include a statement about how source files live there, as opposed to other types of files in the repo.