crickets-and-comb/shared

Differentiate documentation between `shared` and `reference_package`.

Open

#48 创建于 2025年3月26日

在 GitHub 查看
 (0 评论) (0 反应) (0 负责人)Makefile (0 fork)auto 404
documentationhelp wanted

仓库指标

Star
 (2 star)
PR 合并指标
 (PR 指标待抓取)

描述

The README docs in the shared repo and the reference_package repo overlap quite a bit. Also, we abandoned updating documentation in reference_package where it pertains to shared procedures etc., so it has gotten stale.

We need to better differentiate the documentation in shared from the documentation in reference_package. The reference_package documentation shouldn't really document how to use the shared Git submodule other than to refer the user to the shared documentation.

See https://github.com/crickets-and-comb/reference_package/issues/21

贡献者指南