Feature/userguide - #24
Open
knutaa wants to merge 4 commits into
Open
Conversation
Added documentation for Diagram Subset Control feature, including configuration keys, usage examples, precedence rules, and logging details.
This commit updates the 'partY-diagrams.adoc' file to improve the structure and content of the Diagram Generation Configuration Guide. It includes detailed sections on configuration, complexity control, inheritance handling, and type mapping.
This document provides a comprehensive user guide for the user guide generator, detailing its functionality, configuration options, and output structure.
Contributor
|
Hi @knutaa , Looking at this PR, it currently appears to focus primarily on administrator-level documentation in detail. We were also expecting a comprehensive user-focused section in part3.adoc. Could you please split the content so that the administrator and user documentation are separate? This will make it easier to share the user documentation and provide users with quick visibility whenever they need it. |
Author
|
The documentation of diagrams and userguide in
are split into
The original documents are removed for clarity. |
|
|
||
| == Enumeration Display | ||
|
|
||
| === `truncateLargeEnums` |
Contributor
There was a problem hiding this comment.
@knutaa
I think you can add all the possible values, as you wrote in the tooling PR
"truncateLargeEnums": true,
"truncateEnumsCount": 15,
"truncatedMessage": "{field}<color:red>.. truncated (%1$s of %2$s)",
"truncateEnumsCountTable": 50,
"truncatedMessageTable": "[.red]#* .. truncated .. %1$s of %2$s#"
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
3 participants
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.
No description provided.