add more detailed user centric manuals#2990
Open
RolandJentschETAS wants to merge 1 commit into
Open
Conversation
github-project-automation
Bot
added this to
TLC - Technical Lead Circle and S-CORE Roadmap
|
The created documentation from the pull request is available at: docu-html |
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.
This pull request updates the platform repository documentation to clarify and expand the recommended folder structure, especially for user and integration manuals. The changes introduce more detailed guidance on organizing optional user-centric documentation and provide explicit subfolder suggestions for configuration, examples, usage, and performance analysis.
Documentation structure improvements:
manuals/folder to clarify that it may refer to manuals for modules in the reference integration repository.manuals/folder structure for modules and features to explicitly recommend optional subfolders for configuration guides, examples user guides, APIs & usage, and performance analysis, making the documentation structure more modular and user-focused. [1] [2]manuals/folders, suggesting optional subfolders for configuration, examples, usage, and performance analysis to align with the module-level documentation structure. [1] [2]