Skip to content

Commit be257ee

Browse files
authored
docs: add links to docs on readmes (#978)
1 parent baf5e91 commit be257ee

File tree

5 files changed

+15
-1
lines changed

5 files changed

+15
-1
lines changed

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,8 @@ For official documentation, please visit https://dartfrog.vgv.dev.
2323
| [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) |
2424
| [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) |
2525
| [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) |
26+
| [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) |
27+
2628

2729
## Quick Start 🚀
2830

packages/dart_frog/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,10 @@ A fast, minimalistic backend framework for Dart 🎯
1111

1212
Developed with 💙 by [Very Good Ventures][very_good_ventures_link] 🦄
1313

14+
## Documentation 📝
15+
16+
For official documentation, please visit [dartfrog.vgv.dev][docs_link].
17+
1418
## Quick Start 🚀
1519

1620
### Prerequisites 📝
@@ -71,3 +75,4 @@ View the full documentation [here][documentation_link].
7175
[very_good_analysis_badge]: https://img.shields.io/badge/style-very_good_analysis-B22C89.svg
7276
[very_good_analysis_link]: https://pub.dev/packages/very_good_analysis
7377
[very_good_ventures_link]: https://verygood.ventures
78+
[docs_link]: https://dartfrog.vgv.dev

packages/dart_frog_auth/README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Developed with 💙 by [Very Good Ventures][very_good_ventures_link] 🦄
1515

1616
A package that provides the foundation for authentication for a Dart Frog backend server.
1717

18-
Learn more about it on the [official docs](https://dartfrog.vgv.dev/docs/advanced/authentication).
18+
Learn more about it on the [official docs][docs_link].
1919

2020
[ci_badge]: https://github.com/VeryGoodOpenSource/dart_frog/actions/workflows/dart_frog_auth.yaml/badge.svg?branch=main
2121
[ci_link]: https://github.com/VeryGoodOpenSource/dart_frog/actions/workflows/dart_frog_auth.yaml
@@ -33,3 +33,4 @@ Learn more about it on the [official docs](https://dartfrog.vgv.dev/docs/advance
3333
[very_good_analysis_link]: https://pub.dev/packages/very_good_analysis
3434
[very_good_ventures_link]: https://verygood.ventures
3535
[general_http]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication#the_general_http_authentication_framework
36+
[docs_link]: https://dartfrog.vgv.dev/docs/advanced/authentication

packages/dart_frog_cli/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,8 @@ Available commands:
3434
Run "dart_frog help <command>" for more information about a command.
3535
```
3636

37+
Learn more about it on the [official docs][docs_link].
38+
3739
[ci_badge]: https://github.com/VeryGoodOpenSource/dart_frog/actions/workflows/dart_frog_cli.yaml/badge.svg?branch=main
3840
[ci_link]: https://github.com/VeryGoodOpenSource/dart_frog/actions/workflows/dart_frog_cli.yaml
3941
[coverage_badge]: https://raw.githubusercontent.com/VeryGoodOpenSource/dart_frog/main/packages/dart_frog_cli/coverage_badge.svg
@@ -49,3 +51,4 @@ Run "dart_frog help <command>" for more information about a command.
4951
[very_good_analysis_badge]: https://img.shields.io/badge/style-very_good_analysis-B22C89.svg
5052
[very_good_analysis_link]: https://pub.dev/packages/very_good_analysis
5153
[very_good_ventures_link]: https://verygood.ventures
54+
[docs_link]: https://dartfrog.vgv.dev/docs/overview

packages/dart_frog_web_socket/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ WebSocket support for [Dart Frog][dart_frog_link].
1111

1212
Developed with 💙 by [Very Good Ventures][very_good_ventures_link] 🦄
1313

14+
Learn more about it on the [official docs][docs_link].
15+
1416
## Quick Start 🚀
1517

1618
Use `webSocketHandler` to manage `WebSocket` connections in a Dart Frog route handler.
@@ -75,3 +77,4 @@ void main() {
7577
[very_good_analysis_badge]: https://img.shields.io/badge/style-very_good_analysis-B22C89.svg
7678
[very_good_analysis_link]: https://pub.dev/packages/very_good_analysis
7779
[very_good_ventures_link]: https://verygood.ventures
80+
[docs_link]: https://dartfrog.vgv.dev/docs/advanced/web_socket

0 commit comments

Comments
 (0)