Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

[DOC] Add sidebar on homepage of API docs

Abierto
#487 4 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 2 días

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
3/5
Tiempo estimado
1-2 días
Aptitud para principiantes
25/100
Tipo de issue
Documentación
Claridad
Necesita aclaración
Estado de actividad
Estancado
Stack tecnológico
html

Línea de trabajo

Compara las páginas de inicio de la documentación de API de cuDF y cuML con sus páginas principales de documentación, utilizando como referencia las capturas de pantalla y las URL enlazadas. Identifica cómo están configuradas las páginas de destino y la barra lateral; después, determina si la barra lateral puede exponer la página de instalación en docs.rapids.ai/install. Se considera completado cuando la página de inicio de la documentación de API proporciona la navegación solicitada en la barra lateral y una ruta clara hacia la instalación.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

? - Needs Triage doc

Report needed documentation

Describe the documentation you'd like

The home page of the API libraries e.g https://docs.rapids.ai/api/cudf/stable/ and https://docs.rapids.ai/api/cuml/stable/ are mostly landing pages with a summary and a list of the contents of the page. It would be nice is there was a way to configure the landing page to also have the sidebar that is present in the main documentation (see images below). I'm mostly interested a fast way to land on the installation page (https://docs.rapids.ai/install). My user journey (albeit may be unique) was https://github.com/rapidsai/cudf -> https://docs.rapids.ai/api/cudf/stable/ -> https://docs.rapids.ai/api/cudf/stable/user_guide/ then https://docs.rapids.ai/api (once I thought the installation guide would be there) -> https://docs.rapids.ai/install

Nice work on the standardized docs.

Screenshot 2024-03-02 at 6 17 51 PM
Screenshot 2024-03-02 at 6 21 30 PM

Lenguaje dominante
HTML
Estrellas
52
Forks
73
Merge medio
3 d 15 h
PR fusionados (30 d)
7

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de rapidsai/docs

Todos los issues de rapidsai/docs

Issues similares

Más issues de Documentation

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.