conan-io / conan-io/docs

How does conan-docs implement its version switcher?

Open
#3,302 6 comments 0 reactions 0 assignees View on GitHub
type: question
Dominant language
C++
Stars
125
Forks
382
Avg merge
22h 39m
Merged PRs (30d)
21

Description

### Problem Description

According to my understanding, Read The Docs will provide built-in Version/Langauge Switchers. However, it seems that Conan doesn't use RTD. Therefore, I wonder how conan-docs implement its version switcher?

Take CMake Documentation for example. It provides its own version switcher by using [version_switch.js](https://cmake.org/cmake/help/version_switch.js).

And it seems that the locally built documentation won't display the version switcher. How does Conan setup its version switcher?

### Screenshots

![image](https://github.com/conan-io/docs/assets/71438617/dc8c62a7-37d1-4589-9ea6-678962aefc8c)

![image](https://github.com/conan-io/docs/assets/71438617/f824450c-08d9-452a-99db-13830378cc00)

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with the version_switch.js implementation linked in the issue and inspect the Conan documentation build and publishing configuration to identify how the hosted switcher is supplied. Compare that with a locally built documentation site. Done means documenting the switcher's source, setup, and why it is absent from local builds.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.