Curation Guides

This folder contains various task-specific curation guides.

How to add new guides

  1. Create a new markdown file in this directory (bioregistry/docs/guides/)
  2. Use appropriate front-matter so that Jekyll can give it a permalink (see here for an example)
  3. Add it to the list above. Don’t include a forward slash / in the beginning of the link!
  4. Make sure you run npx prettier --prose-wrap always --check "**/*.md" --write to properly format your markdown

What makes a good guide

A good guide is able to educate and guide a curator through a new scenario.

As a guide writer, you should assume a small amount of background knowledge on the Bioregistry and using GitHub, but effectively none about the internal structure of the Bioregistry repository nor its data schema.

Your guide should do the following:

  1. Give some high-level motivation on what curation from your guide accomplishes
  2. Explain in what files curation should be done. Give links to that file on the GitHub main branch for the repository, so they can navigate in the web browser and see it.
  3. Explain how to do the curation
    • Give a step-by-step guide
    • Illustrate your guide with screenshots, code blocks (with highlighting), permalinks to files or sections of files in the Bioregistry GitHub repository