refactor: new CLI commands documentation #413
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
fraxken
reviewed
Aug 11, 2024
|
Sorry, I clicked "Ready for review" by mistake. This PR is still a work in progress, and I will make additional changes before it's ready for a full review. |
|
There is some DS_STORE remaining that need to be deleted |
fraxken
reviewed
Aug 12, 2024
…g, open, report, scorecard, summary, verify)
foucsi
force-pushed
the
improve-documentation
branch
from
b05fcc8
to
191c5c9
Compare
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #413 +/- ##
============================================
- Coverage 100.00% 89.88% -10.12%
============================================
Files 15 20 +5
Lines 649 1196 +547
Branches 0 1 +1
============================================
+ Hits 649 1075 +426
- Misses 0 121 +121 ☔ View full report in Codecov by Sentry. |
fraxken
reviewed
Aug 14, 2024
- Updated auto.md to include missing common options (--silent, --output) - Ensured consistency in the documentation of options across from, cwd, and auto commands - Centralized common options for easier maintenance and readability
- Removed the port configuration example from the CLI options table - Removed outdated IMPORTANT note about the auto command in README.md
fraxken
reviewed
Aug 15, 2024
- Updated `scorecard` command description to include NPM packages and clarify use of OpenSSF scorecard. - Removed unnecessary spaces in documentation. - Standardized the presentation of options in the `auto` command documentation to match other commands.
fraxken
reviewed
Aug 16, 2024
fraxken
changed the title
fraxken
approved these changes
Aug 17, 2024
|
@allcontributors please add @foucsi for doc |
|
I've put up a pull request to add @foucsi! 🎉 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This draft Pull Request aims to improve the documentation of NodeSecure CLI commands. The changes include:
This PR is still a work in progress, and I am open to any feedback to ensure that the documentation is complete and accurate. Thank you for your review and comments!