docs: add links to docs on readmes

VeryGoodOpenSource · Aug 30, 2023 · c4bdfad · c4bdfad
1 parent bb0c751
commit c4bdfad
Show file tree

Hide file tree

Showing 4 changed files with 42 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -18,17 +18,19 @@ For official documentation, please visit https://dartfrog.vgv.dev.
 ## Packages 📦
 
 | Package                                                                                                         | Pub                                                                                                                    |
-| --------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
+|-----------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------|
 | [dart_frog](https://github.com/verygoodopensource/dart_frog/tree/main/packages/dart_frog)                       | [![pub package](https://img.shields.io/pub/v/dart_frog.svg)](https://pub.dev/packages/dart_frog)                       |
 | [dart_frog_gen](https://github.com/verygoodopensource/dart_frog/tree/main/packages/dart_frog_gen)               | [![pub package](https://img.shields.io/pub/v/dart_frog_gen.svg)](https://pub.dev/packages/dart_frog_gen)               |
 | [dart_frog_cli](https://github.com/verygoodopensource/dart_frog/tree/main/packages/dart_frog_cli)               | [![pub package](https://img.shields.io/pub/v/dart_frog_cli.svg)](https://pub.dev/packages/dart_frog_cli)               |
 | [dart_frog_web_socket](https://github.com/verygoodopensource/dart_frog/tree/main/packages/dart_frog_web_socket) | [![pub package](https://img.shields.io/pub/v/dart_frog_web_socket.svg)](https://pub.dev/packages/dart_frog_web_socket) |
+| [dart_frog_auth](https://github.com/verygoodopensource/dart_frog/tree/main/packages/dart_frog_auth)             | [![pub package](https://img.shields.io/pub/v/dart_frog_auth.svg)](https://pub.dev/packages/dart_frog_auth)             |
 
 ## Quick Start 🚀
 
 ### Prerequisites 📝
 
-In order to use Dart Frog you must have the [Dart SDK][dart_installation_link] installed on your machine.
+In order to use Dart Frog you must have the [Dart SDK][dart_installation_link] installed on your
+machine.
 
 ### Installing 🧑‍💻
 
@@ -80,26 +82,48 @@ dart_frog new middleware "/hello/world"
 
 ## Goals 🎯
 
-Dart Frog is built on top of [shelf](https://pub.dev/packages/shelf) and [mason](https://pub.dev/packages/mason) and is inspired by many tools including [remix.run](https://remix.run), [next.js](https://nextjs.org), and [express.js](https://expressjs.com).
+Dart Frog is built on top of [shelf](https://pub.dev/packages/shelf)
+and [mason](https://pub.dev/packages/mason) and is inspired by many tools
+including [remix.run](https://remix.run), [next.js](https://nextjs.org),
+and [express.js](https://expressjs.com).
 
-The goal of Dart Frog is to help developers effectively build backends in Dart. Currently, Dart Frog is focused on optimizing the process of building backends which aggregate, compose, and normalize data from multiple sources.
+The goal of Dart Frog is to help developers effectively build backends in Dart. Currently, Dart Frog
+is focused on optimizing the process of building backends which aggregate, compose, and normalize
+data from multiple sources.
 
-Dart Frog provides a simple core with a small API surface area in order to reduce the learning curve and ramp-up time for developers. In addition, Dart Frog is intended to help Flutter/Dart developers maximize their productivity by having a unified tech stack that enables sharing tooling, models, and more!
+Dart Frog provides a simple core with a small API surface area in order to reduce the learning curve
+and ramp-up time for developers. In addition, Dart Frog is intended to help Flutter/Dart developers
+maximize their productivity by having a unified tech stack that enables sharing tooling, models, and
+more!
 
 ## Extensions 💻
 
-- [VS Code](https://marketplace.visualstudio.com/items?itemName=VeryGoodVentures.dart-frog): extends VS Code with support for Dart Frog and provides tools for effectively managing Dart Frog projects within VS Code.
+- [VS Code](https://marketplace.visualstudio.com/items?itemName=VeryGoodVentures.dart-frog): extends
+  VS Code with support for Dart Frog and provides tools for effectively managing Dart Frog projects
+  within VS Code.
 
 [dart_installation_link]: https://dart.dev/get-dart
+
 [ci_badge]: https://github.com/VeryGoodOpenSource/dart_frog/actions/workflows/main.yaml/badge.svg
+
 [ci_link]: https://github.com/VeryGoodOpenSource/dart_frog/actions/workflows/main.yaml
+
 [coverage_badge]: https://raw.githubusercontent.com/VeryGoodOpenSource/dart_frog/main/packages/dart_frog/coverage_badge.svg
+
 [dart_frog_link_dark]: https://github.com/verygoodopensource/dart_frog#gh-dark-mode-only
+
 [dart_frog_link_light]: https://github.com/verygoodopensource/dart_frog#gh-light-mode-only
+
 [license_badge]: https://img.shields.io/badge/license-MIT-blue.svg
+
 [license_link]: https://opensource.org/licenses/MIT
+
 [logo_black]: https://raw.githubusercontent.com/VeryGoodOpenSource/dart_frog/main/assets/dart_frog_logo_black.png#gh-light-mode-only
+
 [logo_white]: https://raw.githubusercontent.com/VeryGoodOpenSource/dart_frog/main/assets/dart_frog_logo_white.png#gh-dark-mode-only
+
 [very_good_analysis_badge]: https://img.shields.io/badge/style-very_good_analysis-B22C89.svg
+
 [very_good_analysis_link]: https://pub.dev/packages/very_good_analysis
+
 [very_good_ventures_link]: https://verygood.ventures
diff --git a/packages/dart_frog/README.md b/packages/dart_frog/README.md
@@ -11,6 +11,10 @@ A fast, minimalistic backend framework for Dart 🎯
 
 Developed with 💙 by [Very Good Ventures][very_good_ventures_link] 🦄
 
+## Documentation 📝
+
+For official documentation, please visit https://dartfrog.vgv.dev.
+
 ## Quick Start 🚀
 
 ### Prerequisites 📝

diff --git a/packages/dart_frog_cli/README.md b/packages/dart_frog_cli/README.md
@@ -34,6 +34,10 @@ Available commands:
 Run "dart_frog help <command>" for more information about a command.
 ```
 
+## Documentation 📝
+
+For official documentation, please visit https://dartfrog.vgv.dev.
+
 [ci_badge]: https://github.com/VeryGoodOpenSource/dart_frog/actions/workflows/dart_frog_cli.yaml/badge.svg?branch=main
 [ci_link]: https://github.com/VeryGoodOpenSource/dart_frog/actions/workflows/dart_frog_cli.yaml
 [coverage_badge]: https://raw.githubusercontent.com/VeryGoodOpenSource/dart_frog/main/packages/dart_frog_cli/coverage_badge.svg

diff --git a/packages/dart_frog_web_socket/README.md b/packages/dart_frog_web_socket/README.md
@@ -11,6 +11,8 @@ WebSocket support for [Dart Frog][dart_frog_link].
 
 Developed with 💙 by [Very Good Ventures][very_good_ventures_link] 🦄
 
+Learn more about it on the [official docs](https://dartfrog.vgv.dev/docs/advanced/web_socket).
+
 ## Quick Start 🚀
 
 Use `webSocketHandler` to manage `WebSocket` connections in a Dart Frog route handler.
@@ -60,6 +62,8 @@ void main() {
 }
 ```
 
+
+
 [ci_badge]: https://github.com/VeryGoodOpenSource/dart_frog/actions/workflows/dart_frog_web_socket.yaml/badge.svg?branch=main
 [ci_link]: https://github.com/VeryGoodOpenSource/dart_frog/actions/workflows/dart_frog_web_socket.yaml
 [coverage_badge]: https://raw.githubusercontent.com/VeryGoodOpenSource/dart_frog/main/packages/dart_frog_web_socket/coverage_badge.svg