freeCodeCamp / freeCodeCamp/devdocs

CMake: harvest definitions in modules

Abierto
#2,170 0 comentarios 0 reacciones 0 asignados Ver en GitHub
feature
Lenguaje dominante
Ruby
Estrellas
39.5k
Forks
2.6k
Merge medio
4 d 32 min
PR fusionados (30 d)
13

Descripción

# Feature request

## Summary

The CMake documentation includes [pages describing bundled modules](https://cmake.org/cmake/help/latest/manual/cmake-modules.7.html). DevDocs has an index entry for each module (e.g. [CMakeDependentOption](https://devdocs.io/cmake~3.26/module/cmakedependentoption)), but not for each entity defined within (e.g. `cmake_dependent_option` macro).

Harvesting these would improve search user experience, especially when using the technique described in the [user guide](https://devdocs.io/help) under *Prefilling the search field*.

NB to implementor: a module can define more than one item and I’m not sure the markup is consistent between module doc pages.

Guía de contribución

Abrir la guía de contribución

Línea de trabajo

Start by inspecting the existing DevDocs handling of bundled CMake module pages and how module entries are indexed. Compare several CMake module pages to identify the markup used for defined entities, then verify that multiple entities per module are harvested and searchable alongside the module itself.

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

Evaluación

Stack tecnológico
cmake
Área
documentation
Tipo de issue
Nueva funcionalidad
Dificultad
4/5
Tiempo estimado
3-5 días
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
35/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.