crickets-and-comb/shared

Differentiate documentation between `shared` and `reference_package`.

Open

#48 opened on Mar 26, 2025

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Makefile (0 forks)auto 404
documentationhelp wanted

Repository metrics

Stars
 (2 stars)
PR merge metrics
 (PR metrics pending)

Description

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

Contributor guide

Research direction
Compare the README files in the 'shared' and 'reference package' repositories to identify overlapping content. Then, refine the 'shared' documentation to focus on its own resources, and ensure 'reference package' docs only refer to 'shared' without duplicating instructions. Refer to reference package issue #21 for context.
Tech stack
None
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75