Develop documentation
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 4/5
- Tiempo estimado
- 3-5 días
- Aptitud para principiantes
- 45/100
- Tipo de issue
- Documentación
- Claridad
- Bastante claro
- Estado de actividad
- Tranquilo
- Área
- documentation
Línea de trabajo
Comienza con el issue #22 y la documentación de inicio de Zensical para determinar cómo debe iniciarse el sitio de documentación. Construye la primera versión en torno a Referencia rápida, Instalación, IO y Agradecimientos, e incluye al menos un ejemplo completo de generación de máscaras usando napari, X-AnyLabeling, Label Studio o Fiji. Se considera terminado cuando el sitio existe con estas secciones iniciales y el ejemplo se puede utilizar.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
Following #22, a simple documentation site should be initiated. Preference is Zensical.
Components to add on first pass include:
- Quick reference: Worked example starting from existing masks
- A sub-page illustrating how to generate the first mask using a few tools (napari, X-AnyLabeling, Label Studio, Fiji). At least one should go into the first docs produced. Additional examples can be added in subsequent issues.
- Installation
- IO: format specifications for what comes into SST and what is produced
- Acknowledgements
- Lenguaje dominante
- Jupyter Notebook
- Estrellas
- 15
- Forks
- 4
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Preparar el entorno
Este proyecto no incluye contenedor de desarrollo, Dockerfile ni guía de contribución, así que la configuración corre por tu cuenta: empieza por su README y consulta nuestra guía para la primera contribución para los pasos generales.
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de Imageomics/SST
-
napari-sst plugin: integrate reference mask annotation into napariPosiblemente ocupada @sahasra-yikuntam la tomó hace 10 días. Abierto
Imageomics/SST#30 · 1 asignado ·
-
Create initial documentation site contentsPosiblemente ocupada @sahasra-yikuntam la tomó hace 26 días. Abiertodocumentation
Imageomics/SST#29 · 1 asignado ·
-
Set PR preview builds (and site hosting) to go through Cloudflare to prevent gh-pages branch bloat.Posiblemente ocupada @thompsonmj la tomó hace 26 días. Abierto
Imageomics/SST#28 · 1 asignado ·
-
Package for PyPI publicationAbierto
Dificultad 5/5 Más de una semana Aptitud para principiantes 35/100
Imageomics/SST#22 · 1 reacción ·
Todos los issues de Imageomics/SST
Issues similares
-
Broken links in the docsAbierto
Dificultad 1/5 Menos de una hora Aptitud para principiantes 85/100
microsoft/onnxruntime#33018 ·
Los mantenedores suelen responder en 2 días
-
missing content writing algorithms
Dificultad 1/5 Menos de una hora Aptitud para principiantes 88/100
QuantConnect/Documentation#2739 ·
Los mantenedores suelen responder en 1 día
-
:watch: Not Triaged dotnet-target-version
Dificultad 1/5 Menos de una hora Aptitud para principiantes 85/100
Los mantenedores suelen responder en 1 día
-
copilot documentation
Dificultad 2/5 1-3 horas Aptitud para principiantes 88/100
Los mantenedores suelen responder en 2 días
-
Dificultad 1/5 Menos de una hora Aptitud para principiantes 78/100
lichess-org/api#678 ·