Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc fix: Update README.md to remove specific dicscription of paragraph-1 #621

Merged
merged 2 commits into from
Aug 19, 2024

Conversation

yinghu5
Copy link
Collaborator

@yinghu5 yinghu5 commented Aug 19, 2024

According to ##338:

The motivation paragraph 2 is more general and perhaps should move up as paragraph-1. Original paragraph-1 gets too specific into legal documents prematurely.

so Remove the paragraph 1 as it is not related.

Description

The summary of the proposed changes as long as the relevant motivation and context.

Issues

List the issue or RFC link this PR is working on. If there is no such link, please mark it as n/a.

Type of change

List the type of change like below. Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds new functionality)
  • Breaking change (fix or feature that would break existing design and interface)
  • Others (enhancement, documentation, validation, etc.)

Dependencies

List the newly introduced 3rd party dependency if exists.

Tests

Describe the tests that you ran to verify your changes.

According to ##338: 

The motivation paragraph 2 is more general and perhaps should move up as paragraph-1. Original paragraph-1 gets too specific into legal documents prematurely.

so Remove the paragraph 1 as it is not related.
@yinghu5 yinghu5 requested a review from Spycsh as a code owner August 19, 2024 02:51
@yinghu5 yinghu5 removed the request for review from Spycsh August 19, 2024 03:44
@yinghu5 yinghu5 merged commit 5a9c109 into main Aug 19, 2024
7 checks passed
@yinghu5 yinghu5 deleted the yinghu5-patch-1 branch August 19, 2024 03:44
Copy link
Collaborator

@mkbhanda mkbhanda left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor edit suggested.

DocSum/README.md Show resolved Hide resolved
dmsuehir pushed a commit to dmsuehir/GenAIExamples that referenced this pull request Sep 11, 2024
…h-1 (opea-project#621)

* Update README.md

According to #opea-project#338: 

The motivation paragraph 2 is more general and perhaps should move up as paragraph-1. Original paragraph-1 gets too specific into legal documents prematurely.

so Remove the paragraph 1 as it is not related.

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants