aboutcode-org / aboutcode-org/purldb

Improve Documentation

Abierto
#140 0 comentarios 0 reacciones 0 asignados Ver en GitHub
documentation
Lenguaje dominante
HTML
Estrellas
67
Forks
69
Merge medio
8 d 8 h
PR fusionados (30 d)
1

Descripción

We have RTD set up minimally by https://github.com/nexB/purldb/pull/138, just using the README docs for now.

It would be nice to have improved documentation here:

- more complete and detailed API docs
- some tutorials with use cases (indexing packages from a list of PURLs, matching with scancode.io etc)
- reference docs (see https://github.com/nexB/aboutcode/wiki/GSOD-2023#add-reference-documentation-and-getting-started-guides-for-purldb for reference)

Guía de contribución

No hay ninguna guía de contribución indexada para este repositorio

Evaluación

Este issue todavía no se ha evaluado.

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.