Artículo de Blog
Prueba Beta Nuestros Nuevos Documentos para Desarrolladores
Autor
Justin Rice
Fecha de publicación
Desarrolladores
Documentos de desarrollo
Durante los últimos meses, el equipo de productos web de SDF ha estado trabajando en una nueva versión de los documentos para desarrolladores de Stellar. Todavía están en proceso de desarrollo, pero han avanzado mucho, y ahora estamos en un punto en el que realmente podríamos usar tus comentarios.
Hay dos secciones para revisar:
Estas convivirán junto a los documentos existentes de Stellar mientras recopilamos comentarios, hacemos ajustes, completamos el contenido y buscamos y eliminamos cualquier error en la interfaz.
El objetivo es mantener todo lo bueno de los documentos existentes pero simplificar la navegación, mejorar la apariencia y actualizar el contenido para reflejar mejor el estado actual de las cosas. Queríamos hacer las cosas más modulares, por lo que la documentación está organizada en torno a diferentes caminos de aprendizaje, y el plan es agregar nuevos caminos a medida que evolucionen los casos de uso de la red.
Si tienes sugerencias o encuentras errores, fallos u omisiones, por favor presenta PRs o problemas en el nuevo repositorio de documentos o haz un informe usando esta encuesta de typeform. Si te sientes inspirado, también te animamos a contribuir: ¡la documentación, como el código, es open-source!
Qué Probar
Tanto Documentación como Referencia de la API
- Navega usando la tabla de contenidos en la barra lateral izquierda. ¿Es la navegación intuitiva? ¿Te pierdes?
- Cambia tu idioma preferido en un fragmento de código. ¿Se comporta como esperarías? ¿Persiste el cambio de idioma?
- Desplázate horizontalmente en un fragmento de código o en una respuesta de ejemplo. ¿Se comporta como esperarías?
- Intenta editar una página. ¿Qué sucede? ¿Es lo que esperarías?
- ¡Siéntete libre de encontrar otras cosas para romper!
Documentación
- Navega por una página usando el “Esquema de la Página” a la derecha. ¿Es la navegación intuitiva?
- ¿Ves algo en el contenido que sea inexacto o podría mejorarse?
- ¿Tienes ideas para contenido adicional?
Referencia de la API
- Desplázate hacia arriba y hacia abajo en el “desplazamiento infinito” del contenido principal. ¿Los enlaces en la barra de direcciones de tu navegador reflejan el contenido que estás viendo en la ventana de tu navegador?
- Haz clic usando enlaces en el contenido. ¿Qué está roto?
- ¿Está el contenido organizado como esperarías dado tu entendimiento de Horizon? ¿Qué fue difícil de encontrar?
- ¿Puedes encontrar información sobre el endpoint que lista todos los pagos?
- ¿Puedes encontrar información sobre el endpoint que lista todas las ofertas para una cuenta?
Qué No Está Listo
- Todo el contenido aún está en fase de borrador, y seguimos añadiendo más. Estamos abiertos a sugerencias y alentamos las contribuciones.
- No hemos optimizado para otros navegadores además de Chrome en Mac.
Nota: La Referencia de la API no tendrá un diseño responsivo. Nos gustaría que fuera legible en móviles, pero no estará optimizada para móviles.
Enviar Problemas
- Puedes enviar un problema o presentar un PR en el repositorio de GitHub o hacer un informe usando esta encuesta de typeform.
- Por favor incluye un enlace a la página donde estás experimentando el problema, el navegador y dispositivo que estás usando y (opcionalmente) una captura de pantalla.
- Siéntete libre de contribuir de cualquier manera. La documentación, como el código, es open-source.