Some examples need READMEs. - Githubissues

observablehq / examples

Examples of using Observable in a variety of contexts

106 stars 33 forks source link

Some examples need READMEs. #3

Closed mbostock closed 3 years ago

mbostock commented 3 years ago

Rather than the top-level README linking to the live examples in gh-pages, we should add a README to each example’s folder that documents how the example works, and then link there. That way there will be some context to understand what the example is showing and to explain any surprising details.

[x] breakout
[x] custom-data
[x] custom-fixed-width
[x] custom-fluid-width-and-height
[x] custom-fluid-width
[x] iframe-resize
[x] react-dataflow
[x] react-file-attachment
[ ] simple-constant
[ ] simple-generator
[ ] versioning

Also we should add titles to each example README.

mbostock commented 3 years ago

(Noticed that some of the examples do have READMEs, just not the first two that I clicked on. Adding subtasks now.)