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

Interactive examples in generated docs and DDL guide #165

Closed
brendanzab opened this issue Sep 11, 2019 · 1 comment
Closed

Interactive examples in generated docs and DDL guide #165

brendanzab opened this issue Sep 11, 2019 · 1 comment
Labels
A-documentation A-tooling C-feature obsolete Cleaning up the backlog on 2020-10-09.

Comments

@brendanzab
Copy link
Member

Common Trace Format's specification has some interesting interactive examples. You can hover over parts of an example binary file to see how bytes map to part of the spec, and parts of the dumped data:

Screen Shot 2019-09-11 at 10 19 51 am

This might be handy, both for explaining the DDL in the guide, and also for specifications built in the DDL. For example OpenType sometimes adds example tables to the spec.
@brendanzab
Copy link
Member Author

https://github.com/corkami/pics/blob/master/binary/README.md#file-formats

@toothbrush toothbrush added the obsolete Cleaning up the backlog on 2020-10-09. label Oct 9, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
A-documentation A-tooling C-feature obsolete Cleaning up the backlog on 2020-10-09.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@toothbrush @brendanzab