Skip to content

Add docs URL to README & gemspec #170

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.

Sign up for GitHub

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

Merged
brettchalupa merged 1 commit into from
Oct 15, 2025
Merged

Add docs URL to README & gemspec #170

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@ Ruby library and CLI for easily generating beautiful documentation from your Gra

![sample](https://cloud.githubusercontent.com/assets/64050/23438604/6a23add0-fdc7-11e6-8852-ef41e8451033.png)

Key links:

- **Ruby documentation**: [https://rubydoc.info/github/brettchalupa/graphql-docs.git/main](https://rubydoc.info/github/brettchalupa/graphql-docs.git/main).

## Installation

Add the gem to your project with this command:
Expand Down Expand Up @@ -315,7 +319,7 @@ This starts a server at http://localhost:8808 that automatically reloads when yo

### Online Documentation

The API documentation is available online at [RubyDoc.info](https://www.rubydoc.info/gems/graphql-docs).
The API documentation is available online at [https://rubydoc.info/github/brettchalupa/graphql-docs.git/main](https://rubydoc.info/github/brettchalupa/graphql-docs.git/main).

### Documentation Coverage

Expand Down
2 changes: 2 additions & 0 deletions graphql-docs.gemspec
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,8 @@ Gem::Specification.new do |spec|
"bug_tracker_uri" => "https://github.com/brettchalupa/graphql-docs/issues",
"changelog_uri" => "https://github.com/brettchalupa/graphql-docs/blob/main/CHANGELOG.md",
"wiki_uri" => "https://github.com/brettchalupa/graphql-docs/wiki",
"documentation_uri" => "https://rubydoc.info/github/brettchalupa/graphql-docs.git/main",
"source_code_uri" => "https://github.com/brettchalupa/graphql-docs"
}

spec.files = `git ls-files -z`.split("\x0").reject do |f|
Expand Down