Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Simplify installation doc #5282

Open
hcho3 opened this issue Feb 4, 2020 · 0 comments
Open

Simplify installation doc #5282

hcho3 opened this issue Feb 4, 2020 · 0 comments

Comments

@hcho3
Copy link
Collaborator

hcho3 commented Feb 4, 2020

The current installation doc (https://xgboost.readthedocs.io/en/latest/build.html) has accumulated lots of sections over time. It's time to simplify it. I want to make it look simple and easy to use.

Good examples:

The idea is to make the installation doc page less overwhelming, by letting the user filter the doc by the use case they have in mind. The vast majority of users will not want to build XGBoost from the source, so hide the build detail until the user requests it. For example, on the MXNet page, you can select "Build From Source" in the selector in order to display the source build instructions.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants