Improve Quarkiverse extension codestart initial docs structure#53697
Open
suryateja-g13 wants to merge 2 commits intoquarkusio:mainfrom
Open
Improve Quarkiverse extension codestart initial docs structure#53697suryateja-g13 wants to merge 2 commits intoquarkusio:mainfrom
suryateja-g13 wants to merge 2 commits intoquarkusio:mainfrom
Conversation
The generated docs for a new Quarkiverse extension had only a single nav entry (Getting started) and mixed installation content with configuration reference in one page. This change introduces a consistent two-page structure that aligns with established Quarkiverse extensions (e.g. quarkus-web-bundler): - nav.adoc: adds a Configuration Reference entry alongside Getting started - index.adoc: focuses on installation (Maven + Gradle) and a usage stub; removes the inline config reference section - config-reference.adoc: new dedicated page that includes the auto-generated configuration properties include Fixes quarkusio#35367
0cc3c79 to
7602742
Compare
This comment has been minimized.
This comment has been minimized.
The changes to the docs templates (nav, index.adoc, and new config-reference.adoc) affect the expected output in three snapshot files: - dir-tree.snapshot: add config-reference.adoc to the expected tree - nav.adoc snapshot: add Configuration Reference entry - index.adoc snapshot: reflect improved wording and added Gradle snippet; remove inline config reference section (moved to its own page)
Status for workflow
|
Contributor
|
Please update the PR description according to https://github.com/quarkusio/quarkus/blob/main/AI_POLICY.md#signal-to-noise-ratio |
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
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.
Problem
When a new Quarkiverse extension is generated with
quarkus create extension, the initial docs structure is minimal and inconsistent with how established Quarkiverse extensions organise their documentation:Getting startedindex.adocmixes installation instructions with the configuration reference in one pageFix
Introduces a clean two-page structure aligned with established Quarkiverse extensions (e.g. quarkus-web-bundler):
nav.tpl.qute.adoc— adds Configuration Reference alongside Getting started:pages/index.tpl.qute.adoc— focused on installation only:pages/config-reference.tpl.qute.adoc(new file) — dedicated config reference page:Before / After
Before — single nav entry, everything crammed into index.adoc:
After — standard two-page structure:
Test plan
quarkus create extension --codestart quarkiverse my-extensionand verify the generated docs folder contains bothindex.adocandconfig-reference.adocnav.adochas both entriesindex.adoccovers Maven + Gradle installation and has a Usage sectionconfig-reference.adocexists and includes the config properties includeFixes #35367