Show documentation section on software systems home #51
Conversation
This file contains 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
dirkgroot
requested changes
Sep 15, 2022
.../kotlin/nl/avisi/structurizr/site/generatr/site/model/SoftwareSystemHomePageViewModelTest.kt
Outdated
Show resolved
Hide resolved
src/main/kotlin/nl/avisi/structurizr/site/generatr/site/views/SoftwareSystemHomePage.kt
Outdated
Show resolved
Hide resolved
jp7677
force-pushed
the
software-system-home
branch
from
607bba0
to
7c4a989
Compare
Render the first found documentation section (sorted by filename) as home page for software systems. Other documentation section will be (for now) ignored. Fallback to the description when no documentation is present.
jp7677
force-pushed
the
software-system-home
branch
from
7c4a989
to
f172cbc
Compare
dirkgroot
approved these changes
Sep 15, 2022
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.
Render the first found documentation section (sorted by filename) as home page for software systems. Other documentation section will be (for now) ignored. When no documentation is present, the presentation is the same as of now, just showing the description.
The example is extended with a doc.
In the long term, other documentation files could be rendered similar to ADRs, but that is another story.