docs(core): rework of documentation #1558
Merged
Conversation
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
github-actions
bot
added
the
documentation
IvoGoman
force-pushed
the
refactor/docs
branch
2 times, most recently
from
f681950 to
c7a1676
Compare
IvoGoman
force-pushed
the
refactor/docs
branch
from
5da7a27 to
3f4ca8b
Compare
Zaggy21
requested changes
Oct 28, 2025
Contributor
Zaggy21
left a comment
Zaggy21
left a comment
There was a problem hiding this comment.
Nice, the navigation is convenient. The links are broken for me, so I added suggestions for all of them. Also fixed some typos and yamls. Plugin doc is missing the reconcile annotation.
Contributor
Author
|
@Zaggy21 thanks actually we need to remove the md everywhere. |
This PR aims to rework the documetation structure. getting-started/core-concepts should not contain technical details but give a brief overview. How to configure the API resources should be shown under reference/components. This is a more detailed documentation and may contain some additional info on how to use the API. Next to the generated api docs. user-guides should only contain examples/tutorials that guide the user to complete a specific task. to make the navigation and finding related resources easier the refactored docs pages will now have a 'Next steps' section at the bottom of the page
Co-authored-by: Krzysztof Zagorski <[email protected]>
IvoGoman
force-pushed
the
refactor/docs
branch
from
436d23e to
76d463c
Compare
On-behalf-of: @SAP [email protected]
Zaggy21
requested changes
Oct 29, 2025
Contributor
Zaggy21
left a comment
Zaggy21
left a comment
There was a problem hiding this comment.
Just two suggestions left to resolve. Other than that looks great.
IvoGoman
force-pushed
the
refactor/docs
branch
from
bd0a99b to
a2ec344
Compare
Zaggy21
approved these changes
Oct 29, 2025
This was
linked to
issues
Nov 4, 2025
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.
Description
This PR aims to rework the documetation structure.
getting-started/core-concepts should not contain
technical details but give a brief overview.
How to configure the API resources should be shown
under reference/components. This is a more detailed
documentation and may contain some additional info
on how to use the API. Next to the generated api docs.
user-guides should only contain examples/tutorials
that guide the user to complete a specific task.
to make the navigation and finding related resources
easier the refactored docs pages will now have a
'Next steps' section at the bottom of the page
fixes all the broken links
What type of PR is this? (check all applicable)
Related Tickets & Documents
Added tests?
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration
Added to documentation?
Checklist