airajena opened a new pull request, #5391: URL: https://github.com/apache/fineract/pull/5391
## Description: This PR establishes the initial skeleton for publishing Fineract documentation using the [Antora](https://antora.org) static site generator. It consolidates scattered developer guides into a unified "Contributor's Zone" within a standard Antora module structure. This lays the foundation for FINERACT-1959 (migrating content) and FINERACT-1721 (Antora build pipeline). ## Changes - **New Directory Structure**: Created `fineract-doc/modules/` with `ROOT` and `contributor` modules. - **Antora Configuration**: Added `fineract-doc/antora.yml` component descriptor. - **Module Consolidation**: Merged previous `development` content into the `contributor` module. - **Content Provisioning**: Extracted core developer guides from `CONTRIBUTING.md` into dedicated AsciiDoc pages: - `coding-conventions.adoc` - `error-handling.adoc` - `logging-guidelines.adoc` - `checkstyle-and-spotless.adoc` - **Cleanup**: Refined `key-design-principles.adoc` to align with current architecture (removed outdated CQRS sections). ## Implementation Details This PR does **not** replace the existing Asciidoctor Gradle build. The Antora modules exist alongside the current `src/docs/en` structure, enabling a safe and parallel migration. ### Motivation As discussed in FINERACT-1956, documentation logic was scattered. This "docs as code" structure allows for better versioning, navigation, and maintainability. ## Checklist Please make sure these boxes are checked before submitting your pull request - thanks! - [x] Write the commit message as per [our guidelines](https://github.com/apache/fineract/blob/develop/CONTRIBUTING.md#pull-requests) - [x] Acknowledge that we will not review PRs that are not passing the build _("green")_ - it is your responsibility to get a proposed PR to pass the build, not primarily the project's maintainers. - [x] Create/update [unit or integration tests](https://fineract.apache.org/docs/current/#_testing) for verifying the changes made. _(Verified standard Antora structure validity)_ - [x] Follow our [coding conventions](https://cwiki.apache.org/confluence/display/FINERACT/Coding+Conventions). - [ ] Add required Swagger annotation and update API documentation at fineract-provider/src/main/resources/static/legacy-docs/apiLive.htm with details of any API changes _(N/A - specific to documentation)_ - [x] [This PR must not be a "code dump"](https://cwiki.apache.org/confluence/display/FINERACT/Pull+Request+Size+Limit). Large changes can be made in a branch, with assistance. Ask for help on the [developer mailing list](https://fineract.apache.org/#contribute). -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
