Hacia una mejor documentación
Esta página fue traducida por PageTurner AI (beta). No está respaldada oficialmente por el proyecto. ¿Encontraste un error? Reportar problema →
Parte de una gran experiencia para desarrolladores es contar con una excelente documentación. Crear buenos documentos requiere mucho: la documentación ideal debe ser concisa, útil, precisa, completa y atractiva. Recientemente hemos trabajado arduamente para mejorar la documentación basándonos en sus comentarios, y queremos compartir algunas de las mejoras que hemos implementado.
Ejemplos integrados
Cuando aprendes una nueva biblioteca, lenguaje de programación o framework, hay un hermoso momento en que escribes un poco de código, lo pruebas, ves si funciona... y realmente funciona. Has creado algo real. Queríamos llevar esa experiencia visceral directamente a nuestra documentación. Así:
import React, { Component } from 'react';
import { AppRegistry, Text, View } from 'react-native';
class ScratchPad extends Component {
render() {
return (
<View style={{flex: 1}}>
<Text style={{fontSize: 30, flex: 1, textAlign: 'center'}}>
Isn't this cool?
</Text>
<Text style={{fontSize: 100, flex: 1, textAlign: 'center'}}>
👍
</Text>
</View>
);
}
}
AppRegistry.registerComponent('ScratchPad', () => ScratchPad);
Creemos que estos ejemplos integrados, que usan el módulo react-native-web-player con ayuda de Devin Abbott, son una excelente forma de aprender los fundamentos de React Native. Hemos actualizado nuestro tutorial para nuevos desarrolladores de React Native para usarlos siempre que sea posible. Échale un vistazo: si alguna vez has sentido curiosidad por ver qué pasaría si modificas solo un fragmento del código de ejemplo, esta es una forma genial de experimentar. Además, si estás construyendo herramientas para desarrolladores y quieres mostrar muestras en vivo de React Native en tu sitio, react-native-web-player puede simplificarlo.
El motor central de simulación lo proporciona el proyecto react-native-web de Nicolas Gallagher, que permite mostrar componentes de React Native como Text y View en la web. Explora react-native-web si te interesa crear experiencias móviles y web que compartan gran parte de la base de código.
Guías mejoradas
En algunas partes de React Native existen múltiples formas de hacer las cosas, y hemos recibido comentarios de que podríamos ofrecer mejores orientaciones.
Tenemos una nueva guía de Navegación que compara los diferentes enfoques y recomienda qué deberías usar: Navigator, NavigatorIOS, NavigationExperimental. A mediano plazo, estamos trabajando para mejorar y consolidar esas interfaces. A corto plazo, esperamos que esta guía mejorada facilite tu trabajo.
También tenemos una nueva guía sobre manejo de toques que explica conceptos básicos para crear interfaces similares a botones, y un resumen breve de las diferentes formas de manejar eventos táctiles.
Otra área en la que trabajamos es Flexbox. Esto incluye tutoriales sobre cómo manejar diseño con Flexbox y cómo controlar el tamaño de componentes. También incluye una lista poco glamorosa pero útil de todas las props que controlan el diseño en React Native.
Comenzando
Al comenzar a configurar un entorno de desarrollo de React Native en tu máquina, necesitas instalar y configurar varios elementos. Es difícil que la instalación sea una experiencia divertida y emocionante, pero al menos podemos hacerla lo más rápida e indolora posible.
Creamos un nuevo flujo de Comenzando que te permite seleccionar tu sistema operativo de desarrollo y tu sistema operativo móvil desde el principio, proporcionando un lugar conciso con todas las instrucciones de configuración. También revisamos el proceso de instalación para garantizar que todo funcione y que cada punto de decisión tenga una recomendación clara. Tras probarlo con nuestros inocentes compañeros, estamos seguros de que es una mejora.
También trabajamos en la guía para integrar React Native en aplicaciones existentes. Muchas de las aplicaciones más grandes que usan React Native, como la propia aplicación de Facebook, construyen parte de la app con React Native y otra parte con herramientas de desarrollo convencionales. Esperamos que esta guía facilite que más personas puedan crear aplicaciones de esta manera.
Necesitamos tu ayuda
Tu retroalimentación nos indica en qué debemos enfocarnos. Sé que algunas personas leerán esta publicación y pensarán: "¿Mejor documentación? Pfff. ¡La documentación de X sigue siendo deficiente!". Eso es genial, necesitamos esa energía. La mejor manera de darnos feedback depende del tipo de comentario.
Si encuentras un error en la documentación, como descripciones inexactas o código que no funciona, crea un issue. Etiquétalo como "Documentation" para que sea más fácil dirigirlo a las personas adecuadas.
Si no hay un error específico, pero algo en la documentación es fundamentalmente confuso, no es adecuado para un issue de GitHub. En su lugar, publica en Canny sobre el área de la documentación que necesita mejoras. Esto nos ayuda a priorizar cuando realizamos trabajos más generales como la redacción de guías.
¡Gracias por leer hasta aquí y gracias por usar React Native!