freeCodeCamp / freeCodeCamp/devdocs

Allow hiding unwanted sub-sections

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

描述

# Feature request

Provide an option to filter/hide sub-sections/topics of documentation. This can be a toggle and/or shortcut that hides a topic (and conversely un-hide from preferences or from the Documentation's root page).

## Summary

Currently, some documentation are in-depth and contain a number of topics (for example, Terraform contains 204 topics). These topics would fill up the sidebar making it inconvenient to scroll/select through plus the content within them would also be included with searches.

Specifying a subset that we want to focus our attention on would not only increase performance but also make this tool more usable than the original sources this information is coming from.

## Examples

Using Terraform as an example, the included documentation contains 204 topics available for searching.

![Terraform providers](https://user-images.githubusercontent.com/6453466/153261209-a164fda9-aa7e-40f7-a131-857efc65c0b2.png)

Usually, I would only work with a subset of platforms/providers. If I want to search for a specific subnet resource type, I can search for "subnet" through my interfaces but this returns a long list from all providers.

![Subnet Search Results](https://user-images.githubusercontent.com/6453466/153262554-f3cd143c-86ae-46c7-9295-7df12418cc52.png)

If I know I'm only working in OpenStack, then I will need to search for it within these results (notice it at the bottom of the list). If I was able to pre-define which topics to filter all searches and listings, I would be able to quickly identify the resource I need.

贡献指南

打开贡献指南

调研方向

检查 issue 中描述的文档根页面、主题侧边栏、偏好设置和搜索结果。首先确定如何隐藏和恢复选定的主题子集;完成的标准是,隐藏的主题不再出现在列表或搜索结果中,同时用户可以从文档化的入口取消隐藏这些主题。

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

评估

技术栈
terraform
领域
documentation, search
Issue 类型
功能
难度
5/5
预计耗时
一周以上
活跃度
停滞
描述清晰度
基本清楚
新手友好度
30/100

把新 issue 发到你的邮箱

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