crickets-and-comb/shared

Differentiate documentation between `shared` and `reference_package`.

Open

#48 aperta il 26 mar 2025

Vedi su GitHub
 (0 commenti) (0 reazioni) (0 assegnatari)Makefile (0 fork)auto 404
documentationhelp wanted

Metriche repository

Star
 (2 star)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

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

Guida contributor

Direzione di ricerca
Confronta i file README nei repository 'shared' e 'reference package' per identificare i contenuti sovrapposti. Quindi, perfeziona la documentazione di 'shared' per concentrarsi sulle proprie risorse e assicurati che la documentazione di 'reference package' si riferisca solo a 'shared' senza duplicare le istruzioni. Fare riferimento a reference package issue #21 per il contesto.
Tech stack
Nessuno
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Git
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
75