Add README Guidelines and Templates for GenAIExamples #379
+209
−2
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
Signed-off-by: Vikram Srinivasan <vikram.srinivasan@intel.com>
Signed-off-by: alexsin368 <alex.sin@intel.com>
alexsin368
requested review from
chensuyue,
ftian1,
mkbhanda,
preethivenkatesh and
chickenrae
as code owners
alexsin368
requested review from
ashahba,
mkbhanda,
yinghu5 and
NeoZhangJianyu
and removed request for
mkbhanda,
chickenrae,
ftian1,
preethivenkatesh and
chensuyue
vikramts
reviewed
May 17, 2025
| @@ -309,7 +310,7 @@ flowchart LR | |||
|
|
|||
| #### Additional steps if your contribution is Hardware Specific | |||
|
|
|||
| You will need additional steps to configure the CI/CD for first testing and then deploying your merged GenAIComp or GenAIExample. | |||
| You will need additional steps to configure the CI/CD for first testing and then deploying your merged GenAIComp or GenAIExample. | |||
There was a problem hiding this comment.
You will need additional steps to configure the CI/CD to first test and then deploy the GenAIComp or GenAIExample you merged.
vikramts
reviewed
May 17, 2025
| ## Overview | ||
| <What is the purpose of this README file?> | ||
|
|
||
| ##Deployment |
There was a problem hiding this comment.
(missing a space between # and D)
vikramts
approved these changes
May 17, 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.
README Guidelines according to https://intel.sharepoint.com/:w:/s/opea/EZXuMcQ-e6hGk7HYoXcHrHEBlyvPp96LQsv3pFq8J0idjw
Primary README introduces the GenAIExample. Secondary README covers the steps and customization guide on deploying the example. Templates in .md format are also provided.