freeCodeCamp / freeCodeCamp/devdocs

CMake: harvest definitions in modules

Aberta
#2,170 0 comentários 0 reações 0 responsáveis Ver no GitHub
feature
Linguagem predominante
Ruby
Estrelas
39.5k
Forks
2.6k
Merge médio
4d 32min
PRs com merge (30d)
13

Descrição

# 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.

Guia de contribuição

Abrir o guia de contribuição

Direção de pesquisa

Comece inspecionando como o DevDocs lida atualmente com as páginas de módulos CMake incluídas e como as entradas de módulo são indexadas. Compare várias páginas de módulos CMake para identificar a marcação usada para entidades definidas e, em seguida, verifique se várias entidades por módulo são coletadas e podem ser pesquisadas juntamente com o próprio módulo.

Escrita pelo modelo de indexação a partir do texto da issue.

Avaliação

Stack de tecnologia
cmake
Domínio
documentation
Tipo de issue
Funcionalidade
Dificuldade
4/5
Tempo estimado
3-5 dias
Status de atividade
Estagnada
Clareza
Razoavelmente clara
Facilidade para iniciantes
35/100

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.