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.

Sign up for GitHub

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

Jump to bottom

docs: ensure doc consistancy and correctness #87

Merged
merged 23 commits into from
Feb 25, 2021
Merged

docs: ensure doc consistancy and correctness #87

merged 23 commits into from
Feb 25, 2021

Conversation

jonaslagoni
Copy link
Sponsor Member

Description
This PR re-writes some of the documentation for how to the library works.

@jonaslagoni
Copy link
Sponsor Member Author

jonaslagoni commented Feb 22, 2021 •
edited

@smoya and @derberg I would love to get your opinion on the docs and if anything needs to be changed as they are now 😄

fmvilas
fmvilas reviewed Feb 22, 2021
View reviewed changes
docs/input processing.md Outdated Show resolved Hide resolved
smoya
smoya reviewed Feb 22, 2021
View reviewed changes
README.md Outdated Show resolved Hide resolved
@jonaslagoni @smoya
Update README.md
fbb3034 
Co-authored-by: Sergio Moya <1083296+smoya@users.noreply.github.com>
smoya
smoya reviewed Feb 22, 2021
View reviewed changes
README.md Show resolved Hide resolved
smoya
smoya reviewed Feb 22, 2021
View reviewed changes
README.md Show resolved Hide resolved
smoya
smoya reviewed Feb 22, 2021
View reviewed changes
docs/input processing.md Outdated Show resolved Hide resolved
smoya
smoya reviewed Feb 22, 2021
View reviewed changes
docs/input processing.md Outdated Show resolved Hide resolved
smoya
smoya reviewed Feb 22, 2021
View reviewed changes
docs/simplification.md Outdated Show resolved Hide resolved
smoya
smoya reviewed Feb 22, 2021
View reviewed changes
docs/simplification.md Outdated Show resolved Hide resolved
smoya
smoya reviewed Feb 22, 2021
View reviewed changes
docs/simplification.md Outdated Show resolved Hide resolved
smoya
smoya reviewed Feb 22, 2021
View reviewed changes
docs/simplification.md Outdated Show resolved Hide resolved
smoya
smoya reviewed Feb 22, 2021
View reviewed changes
docs/simplification.md Outdated Show resolved Hide resolved
smoya
smoya reviewed Feb 22, 2021
View reviewed changes
docs/simplification.md Outdated Show resolved Hide resolved
@smoya
Copy link
Member

smoya commented Feb 22, 2021

@jonaslagoni Great job here!
I did some reviewing. However and if it sounds ok to you, I would like to do another pass in case you apply some of the suggestions so I can read it closer from the user perspective again.

jonaslagoni and others added 4 commits February 23, 2021 10:33
@jonaslagoni
Merge branch 'master' into feature/rewrite_simplifier_docs
ab64ec3
@jonaslagoni @smoya
Update docs/simplification.md
af777ad 
Co-authored-by: Sergio Moya <1083296+smoya@users.noreply.github.com>
@jonaslagoni
Merge branch 'master' into feature/rewrite_simplifier_docs
6244277
@jonaslagoni @smoya
Update docs/simplification.md
ff03535 
Co-authored-by: Sergio Moya <1083296+smoya@users.noreply.github.com>
@smoya smoya mentioned this pull request Feb 23, 2021
Closed
@jonaslagoni jonaslagoni changed the title chore: ensure doc consistancy and correctness docs: ensure doc consistancy and correctness Feb 23, 2021
smoya
smoya reviewed Feb 23, 2021
View reviewed changes
API.md Show resolved Hide resolved
smoya
smoya reviewed Feb 24, 2021
View reviewed changes
docs/input processing.md Outdated Show resolved Hide resolved
jonaslagoni and others added 3 commits February 24, 2021 17:13
@jonaslagoni
Merge branch 'master-upstream-master' into feature/rewrite_simplifier…
4690ba3 
…_docs

# Conflicts:
#	src/processors/AsyncAPIInputProcessor.ts
@jonaslagoni @smoya
Update docs/input processing.md
cc11198 
Co-authored-by: Sergio Moya <1083296+smoya@users.noreply.github.com>
@jonaslagoni
Changed name of file
f321d0d
smoya
smoya previously approved these changes Feb 25, 2021
View reviewed changes
Copy link
Member

@smoya smoya left a comment

Choose a reason for hiding this comment

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

Great job here! LGTM now 🚀 🌕

@jonaslagoni
Merge branch 'master-upstream-master' into feature/rewrite_simplifier…
697662d 
…_docs

# Conflicts:
#	src/models/CommonModel.ts
@jonaslagoni
Copy link
Sponsor Member Author

jonaslagoni commented Feb 25, 2021 •
edited

Sorry @smoya, had a merge conflict.

Thanks for the review everyone🙇

@smoya
Copy link
Member

smoya commented Feb 25, 2021 •
edited

Ouch, seems like you have another one 😅 @jonaslagoni or at least the branch is not up-to-date with base.

@jonaslagoni
Copy link
Sponsor Member Author

@smoya luckily not a conflict 😄

smoya
smoya approved these changes Feb 25, 2021
View reviewed changes
Copy link
Member

@smoya smoya left a comment

Choose a reason for hiding this comment

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

Fantastic work! 🚀

@jonaslagoni jonaslagoni merged commit 4d26d1a into asyncapi:master Feb 25, 2021
@jonaslagoni jonaslagoni deleted the feature/rewrite_simplifier_docs branch February 25, 2021 11:14
@asyncapi-bot
Copy link
Contributor

🎉 This PR is included in version 0.2.2 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@fmvilas fmvilas fmvilas left review comments

@smoya smoya smoya approved these changes

@derberg derberg Awaiting requested review from derberg

@magicmatatjahu magicmatatjahu Awaiting requested review from magicmatatjahu magicmatatjahu is a code owner

Assignees
No one assigned
Labels
released
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
5 participants
@jonaslagoni @smoya @asyncapi-bot @fmvilas @magicmatatjahu