freeCodeCamp / freeCodeCamp/devdocs

Allow hiding unwanted sub-sections

Aperta
#1,703 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub
feature
Lingua principale
Ruby
Stelle
39.5k
Fork
2.6k
Merge medio
4g 32m
PR unite (30g)
13

Descrizione

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

Guida per i contributori

Apri la guida per i contributori

Valutazione

Questa issue non è ancora stata valutata.

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.