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

Updated the README.md with overview details #32

Merged
merged 25 commits into from
Aug 7, 2023

Conversation

toddysm
Copy link
Contributor

@toddysm toddysm commented Jun 11, 2023

@TheFoxAtWork and @mattfarina related to the notaryproject/specifications#262 we would like to have one central place where the overview is made and refer to it from the other repositories. Please let me know if this PR answers your question posted in notaryproject/specifications#262.

Adding also @iamsamirzon for review.

Copy link
Contributor

@yizha1 yizha1 left a comment

Choose a reason for hiding this comment

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

Thanks @toddysm , I left some comments on typos

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Copy link
Contributor

@TheFoxAtWork TheFoxAtWork left a comment

Choose a reason for hiding this comment

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

There are a few areas that need more clarity but this is a significant improvement, thank you!

I would like to call out that there is one line introduced in the change that provides (perhaps) the most clarification between Notary and Notary Project that should be conveyed throughout both repos

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
yizha1
yizha1 previously approved these changes Jun 15, 2023
Copy link
Contributor

@yizha1 yizha1 left a comment

Choose a reason for hiding this comment

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

LGTM. Once this PR is merged, I will update readme.md files in other repos to refer this one as the overview for the Notary Project, so that folks will understand from any repo what the Notary Project is, and what this specific repo is.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@sajayantony
Copy link

+1 - I feel that this PR clarifies a lot of issues and thank you @toddysm.

Copy link
Contributor

@TheFoxAtWork TheFoxAtWork left a comment

Choose a reason for hiding this comment

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

I've provided several suggested changes to improve the readability and clarity of this PR. Thank you all for taking the time to capture, record, and improve upon the original content to ensure community members understand the differences between the repositories.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
toddysm and others added 18 commits August 3, 2023 13:10
Co-authored-by: Emily Fox <[email protected]>
Signed-off-by: Toddy Mladenov <[email protected]>
Signed-off-by: Toddy Mladenov <[email protected]>
Co-authored-by: Milind Gokarn <[email protected]>
Signed-off-by: Toddy Mladenov <[email protected]>
Signed-off-by: Toddy Mladenov <[email protected]>
Co-authored-by: Emily Fox <[email protected]>
Signed-off-by: Toddy Mladenov <[email protected]>
Signed-off-by: Toddy Mladenov <[email protected]>
Co-authored-by: Milind Gokarn <[email protected]>
Signed-off-by: Toddy Mladenov <[email protected]>
Signed-off-by: Toddy Mladenov <[email protected]>
Co-authored-by: Emily Fox <[email protected]>
Signed-off-by: Toddy Mladenov <[email protected]>
Signed-off-by: Toddy Mladenov <[email protected]>
Co-authored-by: Milind Gokarn <[email protected]>
Signed-off-by: Toddy Mladenov <[email protected]>
Signed-off-by: Toddy Mladenov <[email protected]>
Co-authored-by: Emily Fox <[email protected]>
Signed-off-by: Toddy Mladenov <[email protected]>
Signed-off-by: Toddy Mladenov <[email protected]>
Co-authored-by: Emily Fox <[email protected]>
Signed-off-by: Toddy Mladenov <[email protected]>
Signed-off-by: Toddy Mladenov <[email protected]>
Co-authored-by: Emily Fox <[email protected]>
Signed-off-by: Toddy Mladenov <[email protected]>
Signed-off-by: Toddy Mladenov <[email protected]>
Co-authored-by: Yi Zha <[email protected]>
Signed-off-by: Toddy Mladenov <[email protected]>
Signed-off-by: Toddy Mladenov <[email protected]>
Co-authored-by: Samir Kakkar <[email protected]>
Signed-off-by: Toddy Mladenov <[email protected]>
Signed-off-by: Toddy Mladenov <[email protected]>
@toddysm toddysm force-pushed the feature/project-overview branch from f0af95d to 9a16ee3 Compare August 3, 2023 20:11
Co-authored-by: Milind Gokarn <[email protected]>
Signed-off-by: Toddy Mladenov <[email protected]>
Copy link
Contributor

@gokarnm gokarnm left a comment

Choose a reason for hiding this comment

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

LGTM!

Copy link
Contributor

@yizha1 yizha1 left a comment

Choose a reason for hiding this comment

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

Thanks @toddysm for all these efforts.

LGTM

Copy link
Contributor

@SteveLasker SteveLasker left a comment

Choose a reason for hiding this comment

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

LGTM

README.md Show resolved Hide resolved
Copy link

@priteshbandi priteshbandi left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Member

@FeynmanZhou FeynmanZhou left a comment

Choose a reason for hiding this comment

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

LGTM

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.

10 participants