FINERACT-1956: Add Antora skeleton structure and consolidate contributor guides #5391
+539
−0
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description:
This PR establishes the initial skeleton for publishing Fineract documentation using the Antora 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) .
Changes
fineract-doc/modules/withROOTandcontributormodules.fineract-doc/antora.ymlcomponent descriptor.developmentcontent into thecontributormodule.CONTRIBUTING.mdinto dedicated AsciiDoc pages:coding-conventions.adocerror-handling.adoclogging-guidelines.adoccheckstyle-and-spotless.adockey-design-principles.adocto 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/enstructure, 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!