Conversation
|
Site preview available 🔗 https://ff4j.github.io/docs/pr-8/ |
There was a problem hiding this comment.
Pull request overview
Adds initial documentation for FF4j Spring Boot starters under the “Advanced Concepts → Spring Boot” section, replacing the existing placeholder content.
Changes:
- Documented the two available starters (WebMVC and WebFlux) and compared supported features.
- Added sample Maven dependency + basic configuration + run instructions for each starter.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| - [ | ||
| `ff4j-spring-boot-starter-webmvc`](https://github.com/ff4j/ff4j-spring-boot-starter-parent?tab=readme-ov-file#ff4j-spring-boot-starter-webmvc) - | ||
| The starter for Spring MVC applications. | ||
| - [ | ||
| `ff4j-spring-boot-starter-webflux`](https://github.com/ff4j/ff4j-spring-boot-starter-parent?tab=readme-ov-file#ff4j-spring-boot-starter-webflux) - | ||
| The starter for Spring WebFlux applications. |
There was a problem hiding this comment.
The starter list items appear to break Markdown link syntax by splitting the link’s opening [ onto its own line. This likely renders as a stray [ instead of a clickable link; keep each - [link](url) - description on a single line.
| - [ | |
| `ff4j-spring-boot-starter-webmvc`](https://github.com/ff4j/ff4j-spring-boot-starter-parent?tab=readme-ov-file#ff4j-spring-boot-starter-webmvc) - | |
| The starter for Spring MVC applications. | |
| - [ | |
| `ff4j-spring-boot-starter-webflux`](https://github.com/ff4j/ff4j-spring-boot-starter-parent?tab=readme-ov-file#ff4j-spring-boot-starter-webflux) - | |
| The starter for Spring WebFlux applications. | |
| - [`ff4j-spring-boot-starter-webmvc`](https://github.com/ff4j/ff4j-spring-boot-starter-parent?tab=readme-ov-file#ff4j-spring-boot-starter-webmvc) - The starter for Spring MVC applications. | |
| - [`ff4j-spring-boot-starter-webflux`](https://github.com/ff4j/ff4j-spring-boot-starter-parent?tab=readme-ov-file#ff4j-spring-boot-starter-webflux) - The starter for Spring WebFlux applications. |
| Add the dependency [`ff4j-spring-boot-starter-webmvc`]() | ||
|
|
There was a problem hiding this comment.
This is a broken Markdown link: the dependency text links to () (empty URL). Please link it to the correct starter documentation (for consistency, docs/pages/about/quickstart/index.md links to the starter README in GitHub).
| Add the dependency [`ff4j-spring-boot-starter-webmvc`]() | ||
|
|
There was a problem hiding this comment.
In the WebFlux sample, the dependency text references ff4j-spring-boot-starter-webmvc and also uses an empty () URL. This should reference/link to ff4j-spring-boot-starter-webflux instead.
| === "3. Bootstrap" | ||
|
|
||
| Run the application with `mvn spring-boot:run` and access the FF4j web console at `http://localhost:8080/ff4j-console` No newline at end of file |
There was a problem hiding this comment.
This line says to access the “FF4j web console” for the WebFlux starter, but the feature matrix above indicates WebFlux does not provide the web console. Please adjust this bootstrap step to match the stated capabilities (e.g., point to REST/OpenAPI endpoints instead, or clarify if/when the console is available).
| ```kotlin title="FF4JConfiguration.kt" | ||
| import org.ff4j.FF4j | ||
| import org.ff4j.conf.XmlParser | ||
| import org.springframework.context.annotation.Bean | ||
| import org.springframework.context.annotation.Configuration | ||
|
|
||
| @Configuration | ||
| class FF4JConfiguration { | ||
| @Bean | ||
| fun getFF4J(): FF4j = FF4j(XmlParser(), "ff4j-features.xml") | ||
| } |
There was a problem hiding this comment.
The configuration example is written in Kotlin, but the rest of the docs pages in this section predominantly use Java snippets (e.g., docs/pages/about/advanced-concepts/aop/index.md). Consider providing the equivalent Java configuration (or offering both Java/Kotlin tabs) to stay consistent and avoid confusing readers who follow the Java-based examples elsewhere.
| FF4j has provided Spring Boot starters which helps in integrating FF4j into your Spring Boot | ||
| application. The starters provide autoconfiguration for FF4j, making it easy to set up and use. With |
There was a problem hiding this comment.
The intro sentence has grammatical issues (“starters which helps”) and reads awkwardly. Consider rephrasing to something like “FF4j provides Spring Boot starters that help integrate FF4j into a Spring Boot application”, and keep wording consistent with the rest of the docs.
| FF4j has provided Spring Boot starters which helps in integrating FF4j into your Spring Boot | |
| application. The starters provide autoconfiguration for FF4j, making it easy to set up and use. With | |
| FF4j provides Spring Boot starters that help integrate FF4j into a Spring Boot | |
| application. The starters provide auto-configuration for FF4j, making it easy to set up and use. With |
|
|
||
| ## Overview | ||
|
|
||
| FF4j has 2 Spring Boot starter |
There was a problem hiding this comment.
“FF4j has 2 Spring Boot starter” should be plural and use a clearer phrasing (e.g., “FF4j provides two Spring Boot starters:”).
| FF4j has 2 Spring Boot starter | |
| FF4j provides two Spring Boot starters: |
1 participant
Checklist: