Centralized documentation for developers
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Aptitud para principiantes
- 25/100
- Tipo de issue
- Nueva funcionalidad
- Claridad
- Necesita aclaración
- Estado de actividad
- Estancado
- Stack tecnológico
- javascript
- Área
- documentation
Línea de trabajo
Comienza con la página de developers y sus tutoriales Getting Started y First App; después, revisa la documentación enlazada de solid-client setThing. Evalúa cómo están organizados actualmente los estándares de Solid y los ejemplos específicos de cada plataforma. Se considera completado cuando el alcance solicitado de la documentación centralizada esté definido e incluya fragmentos de código utilizables, datos de ejemplo y resultados esperados.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
Search terms I've used
https://github.com/solid/solidproject.org/issues/492 : I agree with him, but nobody cared
https://github.com/solid/solidproject.org/issues/649 : somewhat related
Is your feature request related to a problem? Please describe.
- The current documentation doesn't provide specific info about how to use Solid standards.
-
For example, to learn how to "set thing" with Solid, I start at Get Started page → Building first app page → scroll to the very bottom → luckily found a reference to "solid-client API" → somehow find the documentation of setThing in a website named Inrupt → learn what
setThing()is -
At the Inrupt website (ig this is made for maintainers rather than general developers), I can only learn that
setThing()sets a thing in the dataset. I hope I can see example code snippets & example data to deal with & example outcomes of running the example code, which would let me know if I'm going on the right track.
-
Possible Solution
A centralized documentation describing each feature of the Solid standards, and example code snippets in every platform of how to use those.
Similar case: AppWrite, which is a community-driven backend provider, has very neat documentations. With this documentation, the developers can easily know if they're on the right track.
- I saw a video of a guy explaining how the documentations there are so neat, in which we can see how important docs are in developing experiences.
Describe alternatives you've considered
Nothing.
Additional context
I really love the idea of Solid. I'm just sad that it's way too difficult to find resources for a newbie like me.
- Lenguaje dominante
- HTML
- Estrellas
- 183
- Forks
- 162
- Merge medio
- 8 h 28 min
- PR fusionados (30 d)
- 1
Preparar el entorno
- Incluye un Dockerfile o un archivo de Docker Compose
- Sin plantilla de pull request
- Leer la guía de contribución
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 solid/solidproject.org
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 70/100
solid/solidproject.org#980 · 13 comentarios ·
-
Add ImagineAbierto
Dificultad 1/5 1-3 horas Aptitud para principiantes 62/100
solid/solidproject.org#270 ·
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 35/100
solid/solidproject.org#968 ·
-
Update list of Solid serversAbierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 56/100
solid/solidproject.org#959 · 3 comentarios ·
-
Dificultad 3/5 1-2 días Aptitud para principiantes 45/100
solid/solidproject.org#958 · 1 comentario ·
Todos los issues de solid/solidproject.org
Issues similares
-
Dificultad 1/5 Menos de una hora Aptitud para principiantes 95/100
ethereum/execution-specs#3859 ·
Los mantenedores suelen responder en 1 día
-
data:http invalid needs triage
Dificultad 1/5 Menos de una hora Aptitud para principiantes 72/100
mdn/browser-compat-data#30900 · 2 comentarios ·
Los mantenedores suelen responder en 1 día
-
Dificultad 1/5 Menos de una hora Aptitud para principiantes 65/100
anthropics/claude-plugins-official#6763 · 10 comentarios · 10 reacciones ·
Los mantenedores suelen responder en 3 días
-
Dificultad 1/5 Menos de una hora Aptitud para principiantes 72/100
AFLplusplus/AFLplusplus#2903 ·
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 62/100
ehmpathy/rhachet-roles-bhuild#474 ·
Los mantenedores suelen responder en 1 día