Skip to content

Fix documentation links. #47

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
merged 1 commit into from
Sep 26, 2023
Merged

Fix documentation links. #47

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
4 changes: 4 additions & 0 deletions protocol-http.gemspec
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,10 @@ Gem::Specification.new do |spec|

spec.homepage = "https://github.com/socketry/protocol-http"

spec.metadata = {
"documentation_uri" => "https://socketry.github.io/protocol-http/",
}

spec.files = Dir.glob(['{lib}/**/*', '*.md'], File::FNM_DOTMATCH, base: __dir__)

spec.required_ruby_version = ">= 2.7.6"
Expand Down
9 changes: 3 additions & 6 deletions readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,11 @@ Provides abstractions for working with the HTTP protocol.

## Usage

Please see the [project documentation](https://github.com/socketry/protocol-http) for more details.
Please see the [project documentation](https://socketry.github.io/protocol-http/) for more details.

- [Getting Started](https://github.com/socketry/protocol-httpguides/getting-started/index) - This guide explains how
to use `protocol-http` for building abstract HTTP interfaces.
- [Getting Started](https://socketry.github.io/protocol-http/guides/getting-started/index) - This guide explains how to use `protocol-http` for building abstract HTTP interfaces.

- [Design Overview](https://github.com/socketry/protocol-httpguides/design-overview/index) - The interfaces provided
by <code class="language-ruby">Protocol::HTTP</code> underpin all downstream implementations. Therefore, we provide
some justification for the design choices.
- [Design Overview](https://socketry.github.io/protocol-http/guides/design-overview/index) - This guide explains the high level design of `protocol-http` in the context of wider design patterns that can be used to implement HTTP clients and servers.

## Contributing

Expand Down