fluxnet-open-source / website

http://fluxnet-open-source.readthedocs.io
3 stars 0 forks source link

Make page for best practices tiers #16

Open jemissik opened 10 months ago

covesturtevant commented 2 months ago

Topics often span multiple tiers (e.g. commenting code vs. automatic documentation) Add different emojis in the individual resources guide pages to indicate which Best Practice Tier it belongs to. Then the Best Practices Page can describe what the flags mean and link to specific sections, e.g. Name of Page#Name of section

jemissik commented 2 months ago

You can create labels for page sections to make cross-referencing easier (and then the references won't break if section headers are edited): https://jupyterbook.org/en/stable/tutorials/references.html