-
Notifications
You must be signed in to change notification settings - Fork 8
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
docs: add the first ADRs #55
Conversation
Thanks for the pull request, @MaferMazu! Please note that it may take us up to several weeks or months to complete a review and merge your PR. Feel free to add as much of the following information to the ticket as you can:
All technical communication about the code itself will be done via the GitHub pull request interface. As a reminder, our process documentation is here. Please let us know once your PR is ready for our review and all tests are green. |
@wlvasquez @julianramirez2, can you review this, please? Your insight will be helpful to be sure of the correctness and clarity of the information. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good to me
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A few minor grammar and formatting recommendations were added for your consideration.
5ea4b61
to
8e8f2c7
Compare
Thanks @julianramirez2 |
@MaferMazu 🎉 Your pull request was merged! Please take a moment to answer a two question survey so we can improve your experience in the future. |
Description
This PR adds 3 ADRs:
And I slightly changed the index to clarify the supporting info.
I made those changes following the ADR template from the OEP-19: Developer Documentation.
Testing instructions
make html
inside the docs directory, and then runpython -m http.server 8200 --directory build/html
.Additional information
Screenshot of the index view
Screenshot of the Fulfillment and refund ADR