Repository navigation
Package exposure items #30
Description
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.
Activity
darribas commentedon May 1, 2020
From the notebooks project, elements that could immediately improve the appearance include:
READMEwhich gets pulled at the introduction of each package notebooks.READMEto be the introduction. Maybe a short description of the pacakge, what it does and key links? This sounds like what theREADMEshould be, but maybe it's different in some contexts. Maybe something like aBLURB.mdfile which could also be pulled on the website?weikang9009 commentedon May 1, 2020
Sounds like a great idea.
We might also want to make sure we are using the same file format for README,
.mdor.rst.jGaboardi commentedon May 1, 2020
Linking the agenda notes where this was originally discussed.