freeCodeCamp / freeCodeCamp/devdocs

CMake: harvest definitions in modules

未关闭
#2,170 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看
feature
主要语言
Ruby
星标
39.5k
派生
2.6k
平均合并
4 天 32 分钟
30 天内合并 PR
13

描述

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

贡献指南

打开贡献指南

调研方向

首先检查 DevDocs 现有的捆绑 CMake 模块页面处理方式,以及模块条目的索引方式。比较多个 CMake 模块页面,以确定定义实体所使用的标记,然后验证每个模块中的多个实体都会被提取,并且可以与模块本身一起搜索。

由索引模型根据 Issue 内容生成。

评估

技术栈
cmake
领域
documentation
Issue 类型
功能
难度
4/5
预计耗时
3-5 天
活跃度
停滞
描述清晰度
基本清楚
新手友好度
35/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。