-
Notifications
You must be signed in to change notification settings - Fork 5
Add Go CLI for auditing docs source files on the local filesystem #85
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
cbullinger
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
non-blocking questions and comments. this seems like a really useful tool! 🎉
| @@ -0,0 +1 @@ | |||
| audit-cli | |||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
do we want to ignore any generated output?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The tool doesn't generate any output in any specific directory that can be ignored. If you're generating output, you need to specify a filepath for the generated output. So there aren't any specific patterns to add to the gitignore at this time.
|
|
||
| Compare file contents to identify differences between files. Supports two modes: | ||
| 1. **Direct comparison** - Compare two specific files | ||
| 2. **Version comparison** - Compare the same file across multiple documentation versions |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
cool!
This is a new
audit-clitool that can help us:This lets us do things like:
I've tried to write it with an extensible architecture so we can grow the commands as we figure out more use cases.