DocHealth

DocHealth is a Ruby gem that scans a given path for Markdown (.md) files and retrieves the last updated date and author. It provides a terminal readout or exports the results to a CSV file, helping you monitor the health of your documentation.

Installation

Install the gem and add it to your application's Gemfile by executing:

bundle add doc_health

If bundler is not being used to manage dependencies, install the gem manually:

gem install doc_health

Usage

To scan a directory for Markdown files and display the last modified date and author, run:

doc-health --path /path/to/docs

To output the results to a CSV file:

doc-health --path /path/to/docs --csv

Development

After cloning the repository, install dependencies:

bin/setup

Run the tests:

rake test

Use bin/console for an interactive prompt to experiment with the code.

To install this gem locally:

bundle exec rake install

To release a new version:

1. Update the version number in lib/doc_health/version.rb.
2. Run:

bundle exec rake release

This will create a git tag, push commits and the tag, and publish the gem to RubyGems.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/YOUR_USERNAME/doc_health.