[EXTERNAL] docs(0-shell
optionals): refactoring of 0-shell optional docs
#2998
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Why?
This project has unclear and inconsistent requirements to the audit file, as well as having redundant audit files. This fix attempt to solve some of the inconsistencies, however in the solution overview will mention some of the unclear gaps still remaining in the requirements and left up to the maintainers to fix as they see fit.
This project has inconsistent requirements, as well as having redundant audit files.
Implementation Details
audit/README.md
file to stay consistent with other projects.0-shell
project.Command::new
to spawn a python process. The other unclear point is the use of2>1 >/dev/null
, I was not sure about this point, as it was not required in the main project, so i left it up to the 01 staff to decide how to introduce this, as well as if my python fix is sufficient.audit/README.md
and removed the one in the root to stay consistent with other projects.0-shell
project.