Skip to article frontmatterSkip to article content
Site not loading correctly?

This may be due to an incorrect BASE_URL configuration. See the MyST Documentation for reference.

Editorial Guidelines

The REMARK editor role is responsible for:

  1. Guaranteeing that listed REMARKs are compliant with the REMARK standard.

  2. Adding the metadata needed for the REMARK to be published to the Econ-ARK website.

Reviewing a Submission

When an author submits a pull request adding a new REMARKs/{name}.yml catalog entry:

  1. Verify the linked repository meets the requirements for the claimed tier (see REMARK Guidelines).

  2. Run python cli.py lint REMARKs/{name}.yml to check compliance automatically.

  3. Confirm reproduce.sh executes successfully in the provided environment.

  4. Check that CITATION.cff and REMARK.md (if required by the target tier) are present and well-formed.

Indexing a REMARK on the Website

The Econ-ARK website at econ-ark.org/materials is generated automatically from this repository’s catalog entries combined with metadata from each individual REMARK repository. See REMARK Ecosystem Workflow for the full pipeline.

To add a REMARK to the catalog, merge the PR that adds its REMARKs/{name}.yml file. The PR will point to the author’s repository. On acceptance, the team will create a fork of the author’s repo under the econ-ark organization to preserve the state at which it was tested and verified to work; the catalog (and website) will then point to that fork until the author submits a new version. When the author submits a new version, the team will update the fork as long as reproduce.sh runs and the revised draft still meets REMARK requirements. The author keeps ownership and can continue developing. The website will update within 24 hours via the automated workflow.

Each catalog entry is a YAML file with at minimum:

name: project-name
remote: https://github.com/org/repo
title: Human Readable Title

The website generation script (populate_remarks.py in the econ-ark.org repo) reads CITATION.cff and REMARK.md from each linked repository to build the material pages.

Entries whose repository is not public yet

A REMARK can be listed before its repository is public, so that the catalog stays the one list of every REMARK. Add private: true to its entry:

name: project-name
remote: https://github.com/org/repo
title: Human Readable Title
private: true