Docs: order documentation in MTL #1024
Open
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
skolelis
requested review from
PanKaker,
DawidWesierski4,
Sakoram and
Falron98
as code owners
DawidWesierski4
changed the title
DawidWesierski4
requested changes
Dec 19, 2024
doc/png/arch.svg
Outdated
There was a problem hiding this comment.
There was a problem hiding this comment.
I added this drawing now, but it should be added few months ago. I had it ready then, but somehow was ommitted. Then just ST41 was added and I also removed I from IMTL -> MTL.
I dont know about other necessary changes .
formatting of source code blocks among others
Sakoram
reviewed
Jan 13, 2025
adding links to introductions before including (in case of watching .MD file from GitHub, not from Sphinx)
formatting of source code blocks among others
adding links to introductions before including (in case of watching .MD file from GitHub, not from Sphinx)
skolelis
changed the title
skolelis
changed the title
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.
Docs: order documentation in MTL (and also paralely in BCS and MCM repos (as MTL will be used as sub-module there)).
Style of chapters change,
comas, points, colons, numbering of sections,
style of source code blocks consistent,
source code with commend lines to be paste'able for user,
isolate some parts of the text to be reused also in the documents of others repositories.
Sphinx added generating the documentaries.
Added ST41 to the architecture diagram.
Added X540-AT2/X550T NICs to the architecture diagram.