Skip to content

add more detailed user centric manuals#2990

Merged
RolandJentschETAS merged 3 commits into
eclipse-score:mainfrom
etas-contrib:improvement_manuals_folders
Jun 17, 2026
Merged

add more detailed user centric manuals#2990
RolandJentschETAS merged 3 commits into
eclipse-score:mainfrom
etas-contrib:improvement_manuals_folders

Conversation

@RolandJentschETAS

Copy link
Copy Markdown
Contributor

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:

  • Expanded the description of the top-level manuals/ folder to clarify that it may refer to manuals for modules in the reference integration repository.
  • Updated the 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]
  • Added similar recommendations for component-level manuals/ folders, suggesting optional subfolders for configuration, examples, usage, and performance analysis to align with the module-level documentation structure. [1] [2]

@github-actions

Copy link
Copy Markdown

The created documentation from the pull request is available at: docu-html

@anmittag

Copy link
Copy Markdown
Member

https://eclipse-score.github.io/score/pr-2990 is not accessible to review the outcome

anmittag
anmittag previously approved these changes Jun 17, 2026

@anmittag anmittag left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

https://eclipse-score.github.io/score/pr-2990 is not accessible to review the output

@RolandJentschETAS RolandJentschETAS merged commit fc14a43 into eclipse-score:main Jun 17, 2026
8 checks passed
@github-project-automation github-project-automation Bot moved this from Backlog to Done in S-CORE Roadmap Jun 17, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Done
Status: Done

Development

Successfully merging this pull request may close these issues.

2 participants