Merged
Conversation
github-actions
bot
added
the
pull request
TjazVracko
requested changes
Mar 2, 2025
Contributor
TjazVracko
left a comment
TjazVracko
left a comment
There was a problem hiding this comment.
Good stuff. I will comment on twister.yml in the next PR.
I added some comments about things you could still improve in the template and fixed some grammar mistakes.
MarkoSagadin
force-pushed
the
feature/restructure_docs
branch
from
26935b4 to
4d3c98a
Compare
As we will soon transition from east to twister for the purposes of release artefacts generations it is expected that some documentation will have to be written for that. As the current state of the template repo doesn't really have a nice place to plug-in that documentation somewhere and since some time passed since we were last updating the READMEs here, this commit does some restructuring of the existing docs. The general idea: - Add doc/ folder. It should be used to contain all project specific documentation. - Add doc/development folder. It should contain all documents that are somehow connected with the development aspect of the project.
MarkoSagadin
force-pushed
the
feature/restructure_docs
branch
from
4d3c98a to
b5bf535
Compare
TjazVracko
approved these changes
Mar 5, 2025
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
2 participants
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
As we will soon transition from east to twister for the purposes of
release artefacts generations it is expected that some documentation
will have to be written for that.
As the current state of the template repo doesn't really have a nice
place to plug-in that documentation somewhere and since some time passed
since we were last updating the READMEs here, this commit does some
restructuring of the existing docs.
The general idea:
documentation.
somehow connected with the development aspect of the project.
Areas of interest for the reviewer
Does the restucturing make sense? Are the new READMEs in the right place?
Checklist
After-review steps