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

[hint compat] Add architeture documentation #1749

Closed
molant opened this issue Jan 23, 2019 · 2 comments
Closed

[hint compat] Add architeture documentation #1749

molant opened this issue Jan 23, 2019 · 2 comments

Comments

@molant
Copy link
Member

molant commented Jan 23, 2019

📚 Docs improvements

The compat-api hint is pretty big and complex. We need to document how it works, ideally with some diagrams and such, in an architecture.md file to make sure we don't forget how it works in a couple months.

@bruiztorres
Copy link
Contributor

About the documentation I’m not 100% sure about what kind of diagrams you are expecting. Could you check this diagram and let me know your feedback?
compat-api-flow-2

@antross antross added this to the 1902-1 milestone Jan 28, 2019
@molant
Copy link
Member Author

molant commented Jan 28, 2019

This diagram looks good. I think that we will need more detail in the documentation with examples of Error refinement, quirks, etc.

@antross anything else you can think of?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants