Skip to content

Add link to documentation in Readme #307

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

Closed
wants to merge 2 commits into from

Conversation

stevehanson
Copy link

This update just adds a link to the documentation in the readme so people can find it without having to Google.

This update just adds a link to the documentation in the readme so people can find it without having to Google.
@olleolleolle
Copy link
Contributor

Perhaps this is an even better documentation link?

https://www.rubydoc.info/github/ruby-ldap/ruby-net-ldap/master

@stevehanson
Copy link
Author

@olleolleolle Good call. I went ahead and updated it. Thanks.

@olleolleolle
Copy link
Contributor

olleolleolle commented Jun 19, 2018

@stevehanson I have thought about this, and came to this: the gemspec can have this metadata, too.

Here's an example from another project, which has defined every metadata field supported by RubyGems:

  s.metadata = {
    "bug_tracker_uri" => "https://github.com/celluloid/celluloid/issues",
    "changelog_uri" => "https://github.com/celluloid/celluloid/blob/master/CHANGES.md",
    "documentation_uri" => "https://www.rubydoc.info/gems/celluloid",
    "homepage_uri" => "https://celluloid.io/",
    "mailing_list_uri" => "http://groups.google.com/group/celluloid-ruby",
    "source_code_uri" => "https://github.com/celluloid/celluloid",
    "wiki_uri" => "https://github.com/celluloid/celluloid/wiki"
}

(documentation_uri is what we're discussing here.)

@HarlemSquirrel
Copy link
Member

Thanks but this was taken care of by #318

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants