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

📝 Rewrites INSTALLATION.MD in a shorter and clearer form #728

Merged
merged 1 commit into from
Nov 9, 2023

Conversation

AlexandreSajus
Copy link
Contributor

Multiple people had trouble with building the docs. The installation instructions are currently very complete but also very dense, which leads to confusion. Also, most editors of the docs do not need to know all the options they have for building the doc. I rewrote the instructions in a simple 3-step process:

Before

image

After

image

@AlexandreSajus AlexandreSajus added the 📄 Documentation Internal or public documentation label Nov 9, 2023
@AlexandreSajus AlexandreSajus self-assigned this Nov 9, 2023
Copy link
Member

@jrobinAV jrobinAV left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why not.

@AlexandreSajus AlexandreSajus merged commit 05d5354 into develop Nov 9, 2023
1 check passed
@AlexandreSajus AlexandreSajus deleted the installation_md_rewrite branch November 9, 2023 17:04
@AlexandreSajus AlexandreSajus removed the request for review from FabienLelaquais November 9, 2023 17:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📄 Documentation Internal or public documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants