Open darribas opened 4 years ago
From the notebooks project, elements that could immediately improve the appearance include:
README
which gets pulled at the introduction of each package notebooks.README
to be the introduction. Maybe a short description of the pacakge, what it does and key links? This sounds like what the README
should be, but maybe it's different in some contexts. Maybe something like a BLURB.md
file which could also be pulled on the website?Sounds like a great idea.
We might also want to make sure we are using the same file format for README, .md
or .rst
.
Linking the agenda notes where this was originally discussed.
Starting this issue to discuss ideally how to structure information and meta data about each package so it's easier to consume in "aggregators" (meta-website, notebooks project, etc.). Looping also @knaaptime as per call discussion.