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

Add diagram of how parsing works to contributing docs #820

Open
honzajavorek opened this issue Jul 17, 2017 · 2 comments
Open

Add diagram of how parsing works to contributing docs #820

honzajavorek opened this issue Jul 17, 2017 · 2 comments
Labels
Context: docs

Comments

@honzajavorek
Copy link
Contributor

honzajavorek commented Jul 17, 2017 •
edited
Loading

Add following image to contributing docs:

img_3399

Smaller scope could be put into fury.js README as well. In some sense this issue is similar to apiaryio/gavel-spec#12.
@honzajavorek honzajavorek mentioned this issue Aug 3, 2017
Closed
@honzajavorek
Copy link
Contributor Author

Schema of inner Dredd architecture should be added to docs and explained as well. This is from our secret archives:

upload_2_1_2016_at_1_49_05_pm

@honzajavorek honzajavorek mentioned this issue Jan 3, 2018
Closed
@honzajavorek
Copy link
Contributor Author

https://twitter.com/mtnygard/status/1079471792291491840

When diagramming, make sure your readers know a) what the elements are; b) what the relationships mean; and c) what the constraints are. That’s the meta-model necessary to understand the model.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Context: docs
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@honzajavorek