Skip to content

Commit 34b28a0

Browse files
authored
Documentation cleanup (#23)
* Add CHANGELOG.md to the generated YARD docs * Add documentation link to README.md * Change the GitHub Actions workflow name from "Ruby" to "CI Build" * In the Gemspec, reference CHANGELOG.md on RubyGems.org
1 parent e483e79 commit 34b28a0

File tree

4 files changed

+10
-4
lines changed

4 files changed

+10
-4
lines changed

.github/workflows/main.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: Ruby
1+
name: CI Build
22

33
on:
44
push:

.yardopts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,5 @@
22
--hide-void-return
33
--markup-provider=redcarpet
44
--markup markdown
5+
- CHANGELOG.md
56
- LICENSE.md

README.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,18 @@
11
# The ProcessExecuter Gem
22

33
[![Gem Version](https://badge.fury.io/rb/process_executer.svg)](https://badge.fury.io/rb/process_executer)
4-
[![Build Status](https://github.com/main-branch/process_executer/workflows/Ruby/badge.svg?branch=main)](https://github.com/main-branch/process_executer/actions?query=workflow%3ARuby)
4+
[![Documentation](https://img.shields.io/badge/Documentation-Latest-green)](https://rubydoc.info/gems/process_executer/)
5+
[![Change Log](https://img.shields.io/badge/CHANGELOG-Latest-green)](https://rubydoc.info/gems/process_executer/file/CHANGELOG.md)
6+
[![Build Status](https://github.com/main-branch/process_executer/workflows/CI%20Build/badge.svg?branch=main)](https://github.com/main-branch/process_executer/actions?query=workflow%3ACI%20Build)
57
[![Maintainability](https://api.codeclimate.com/v1/badges/0b5c67e5c2a773009cd0/maintainability)](https://codeclimate.com/github/main-branch/process_executer/maintainability)
68
[![Test Coverage](https://api.codeclimate.com/v1/badges/0b5c67e5c2a773009cd0/test_coverage)](https://codeclimate.com/github/main-branch/process_executer/test_coverage)
79

810
## Features
911

10-
This gem contains the following features:
12+
[Full YARD documentation](https://rubydoc.info/gems/process_executer/) for this
13+
gem is hosted on RubyGems.org.
14+
15+
This gem contains the following important classes:
1116

1217
### ProcessExecuter::MonitoredPipe
1318

process_executer.gemspec

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
1818

1919
spec.metadata['homepage_uri'] = spec.homepage
2020
spec.metadata['source_code_uri'] = 'https://github.com/main-branch/process_executer'
21-
spec.metadata['changelog_uri'] = 'https://github.com/main-branch/process_executer'
21+
spec.metadata['changelog_uri'] = 'https://rubydoc.info/gems/process_executer/file/CHANGELOG.md'
2222

2323
# Specify which files should be added to the gem when it is released.
2424
# The `git ls-files -z` loads the files in the RubyGem that have been added into git.

0 commit comments

Comments
 (0)