feat(docs): add comprehensive Antora documentation structure#23
Merged
feat(docs): add comprehensive Antora documentation structure#23
Conversation
jimisola
force-pushed
the
docs/add-antora-structure
branch
from
152579f to
983e0bd
Compare
jimisola
changed the title
Create Antora-based documentation structure matching the Maven plugin pattern: - antora.yml: Component descriptor with plugin metadata - antora-playbook.yml: Playbook configuration for building the documentation site - modules/ROOT/nav.adoc: Navigation structure - modules/ROOT/pages/: - index.adoc: Main documentation page - description.adoc: Features, quick start, and requirements - configuration.adoc: Configuration parameters with examples - usage.adoc: Usage examples and task information - license.adoc: License information Content adapted from README.adoc with Gradle-specific details and examples. Resolves #21 Signed-off-by: Jimisola Laursen <jimisola@jimisola.com>
jimisola
force-pushed
the
docs/add-antora-structure
branch
from
983e0bd to
b473a48
Compare
jimisola
changed the title
jimisola
changed the title
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
Implements Antora-based documentation structure matching the Maven plugin pattern for consistency across the reqstool project.
Changes
docs/README.adocto separate documentation pages:description.adoc: Features, quick start, and requirementsconfiguration.adoc: Configuration parameters with Gradle-specific examplesusage.adoc: Usage examples and task informationlicense.adoc: License informationantora.yml: Component descriptorantora-playbook.yml: Site playbook for building documentationImplementation
The existing
publish_gh_pages.ymlworkflow is already configured to build and deploy this documentation to GitHub Pages, so no workflow changes are needed.References