Skip to content

Commit

Permalink
Merge pull request #3183 from MrRawbin/cleanup_introduction_docs
Browse files Browse the repository at this point in the history
📖 Cleaned up Introduction docs
  • Loading branch information
jknack authored Oct 22, 2023
2 parents 90b4396 + 482f2e0 commit bfc6ec8
Showing 1 changed file with 11 additions and 10 deletions.
21 changes: 11 additions & 10 deletions docs/asciidoc/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ fun main(args: Array<String>) {
====
Latest Release: https://github.com/jooby-project/jooby/releases/tag/v{joobyVersion}[{joobyVersion}].
Looking for previous version?
Looking for a previous version?
* Access to link:v2[2.x] documentation. See link:/migration/3.x[migrating from 2.x to 3.x]
* Access to link:v1[1.x] documentation.
Expand All @@ -73,15 +73,16 @@ Looking for previous version?
* Increase productivity with <<development-compilation-restart, Hot-Reload for development>>
* Script/lambda routes using fluent API
* <<mvc-api, MVC routes>> using Jooby or JAX-RS annotations
* link:modules/openapi[OpenAPI 3] supports
* link:modules/openapi[OpenAPI 3] support
* <<execution-model, Event Loop and blocking execution modes>>
* <<responses, Reactive responses>> (Completable Futures, RxJava, Reactor, SmallRye types and Kotlin Coroutines)
* <<server, Multi-server>> including https://www.eclipse.org/jetty[Jetty], https://netty.io[Netty] and http://undertow.io[Undertow]
* Jump to full-stack framework with extension/plugin mechanism and variety of link:modules[]
* Make the jump to full-stack framework with the extension/plugin mechanism and a variety of link:modules[]

=== Script API

Script API (a.k.a script routes) provides a fluent DSL, reflection and annotation free based on `lambda` functions.
Script API (a.k.a. script routes) provides a fluent DSL based on `lambda` functions, free of
reflection and annotations.

We usually extend `Jooby` and define routes in the instance initializer:

Expand Down Expand Up @@ -119,10 +120,10 @@ fun main(args: Array<String>) {
}
----

For Java applications we favor extending `Jooby` because DSL looks better (no need
prefix the `get` method with a variable)
For Java applications we favor extending `Jooby` because the DSL looks better (no need
to prefix the `get` method with a variable).

This is not strictly necessary (of course), you may prefer to do it without extending `Jooby`:
This is not strictly necessary (of course); you may prefer to do it without extending `Jooby`:

.Script without subclass:
[source,java,role="primary"]
Expand Down Expand Up @@ -155,12 +156,12 @@ fun main(args: Array<String>) {
}
----

In case of Kotlin, it doesn't matter which one you choose. DSL looks great with or without extending
For Kotlin, it doesn't matter which one you choose. The DSL looks great with or without extending
`Kooby`.

=== MVC API

The MVC API (a.k.a mvc routes) uses annotation to define routes and byte code generation to execute
The MVC API (a.k.a. MVC routes) uses annotation to define routes and byte code generation to execute
them.

.MVC API:
Expand Down Expand Up @@ -211,7 +212,7 @@ fun main(args: Array<String>) {
}
----

More about MVC and JAX-RS support in the <<mvc-api, MVC API>> chapter.
Read more about MVC and JAX-RS support in the <<mvc-api, MVC API>> chapter.


include::getting-started.adoc[]
Expand Down

0 comments on commit bfc6ec8

Please sign in to comment.