From c75894fbd855d3611b574fb7d4c97cd2779b2346 Mon Sep 17 00:00:00 2001 From: Samuel Williams Date: Wed, 31 Jan 2024 17:51:27 +1300 Subject: [PATCH] Improved documentation links. --- .github/{FUNDING.yml => funding.yml} | 0 falcon.gemspec | 4 ++++ gems.rb | 1 - readme.md | 14 +++++++++++++- 4 files changed, 17 insertions(+), 2 deletions(-) rename .github/{FUNDING.yml => funding.yml} (100%) diff --git a/.github/FUNDING.yml b/.github/funding.yml similarity index 100% rename from .github/FUNDING.yml rename to .github/funding.yml diff --git a/falcon.gemspec b/falcon.gemspec index 33a632e8..07ce94bd 100644 --- a/falcon.gemspec +++ b/falcon.gemspec @@ -15,6 +15,10 @@ Gem::Specification.new do |spec| spec.homepage = "https://github.com/socketry/falcon" + spec.metadata = { + "documentation_uri" => "https://socketry.github.io/falcon/", + } + spec.files = Dir.glob(['{bake,bin,lib}/**/*', '*.md'], File::FNM_DOTMATCH, base: __dir__) spec.executables = ["falcon", "falcon-host"] diff --git a/gems.rb b/gems.rb index 47245582..6f5584e0 100644 --- a/gems.rb +++ b/gems.rb @@ -20,7 +20,6 @@ gem "bake-modernize" gem "bake-gem" - gem "bake-github-pages" gem "utopia-project" end diff --git a/readme.md b/readme.md index 682388e1..c1ac48fb 100644 --- a/readme.md +++ b/readme.md @@ -27,7 +27,19 @@ Please visit [Socketry.io](https://socketry.io) to register and subscribe. ## Usage -Please see the project documentation or run it locally using `bake utopia:project:serve`. +Please see the [project documentation](https://socketry.github.io/falcon/) for more details. + + - [Getting Started](https://socketry.github.io/falcon/guides/getting-started/index) - This guide explains how to use Falcon for Ruby web application development. + + - [Rails Integration](https://socketry.github.io/falcon/guides/rails-integration/index) - This guide explains how to host Rails applications with Falcon. + + - [Deployment](https://socketry.github.io/falcon/guides/deployment/index) - This guide explains how to use Falcon in production environments. + + - [Extended Features](https://socketry.github.io/falcon/guides/extended-features/index) - This guide explains some of the extended features and functionality of Falcon. + + - [Performance Tuning](https://socketry.github.io/falcon/guides/performance-tuning/index) - This guide explains the performance characteristics of Falcon. + + - [How It Works](https://socketry.github.io/falcon/guides/how-it-works/index) - This guide gives an overview of how Falcon handles an incoming web request. ## Contributing