SWDEV-427628 - Documentation restructure #3405
Closed
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
MathiasMagnus
force-pushed
the
rocdoc-195
branch
from
b484877
to
b31a2a3
Compare
MathiasMagnus
force-pushed
the
rocdoc-195
branch
from
b31a2a3
to
ead76d3
Compare
As part of the diátaxis reorg, docs are being distributed to the 4 quadrants. Some of the existing content doesn't fit well into any of the quadrants and will require a rewrite. Until then, they will be exposed as legacy, to not remove content.
In an attempt at better communicate to users that documentation is not meant to be consumed by browsing the code, the content is being ported to ReST. This also allows for better extensibility and removes the need for resorting to non-standard extensions (MyST).
The array of built-in functions documented as standalone text proved to easily go out of sync with the compiler functionality. It was decided that it's best consumed
MathiasMagnus
force-pushed
the
rocdoc-195
branch
from
ead76d3
to
d4b4a5a
Compare
MathiasMagnus
requested review from
gargrahul,
mangupta and
rakesroy
as code owners
|
!verify |
|
All changes have been merged in Gerrit HIP. |
|
fee13d6 contains the change. |
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.
This PR fixes the associated JIRA ticket. It is broken into multiple commits for easier review.