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.

Sign up for GitHub

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

Jump to bottom

Replicable installation instructions #478

Merged
merged 5 commits into from
Nov 6, 2023
Merged

Replicable installation instructions #478

merged 5 commits into from
Nov 6, 2023

Conversation

alandefreitas
Copy link
Collaborator

This PR updates the installation instructions in the documentation and the README.md files to make the process of building MrDocs replicable by users.

  • The LLVM version is updated to 29b20829 in all documents, which has been the requirement since bd103aa.
  • LLVM CMake presets are provided so that users can build LLVM for MrDocs with the exact options required or recommended by MrDocs.
  • MrDocs CMake presets are updated to use variables instead of hard-coded paths so they can be more easily reused.
  • The binaries on the website are updated to reflect the requirements and allow users to build MrDocs with all CMake build types.
  • Direct links to the binaries are provided and a brief explanation is provided for each.
  • An example manifest file is provided for MrDocs.
  • All sections are updated to describe how to use these resources.

@alandefreitas
build: vcpkg manifest example
7c76453
@alandefreitas
build: cmake presets use variable-based paths
e90f4d0 
Variable-based paths make results more replicable by users. This commit also sets the preset version to 3, as it's the highest version supported by the build process, which relies on CMake 3.22 from Ubuntu 22.04.
@alandefreitas
build: LLVM presets
0ee673c
@alandefreitas
docs: antora playbooks refer to mrdocs repo
5a559f7 
The previously had to still refer to the mrdox repository.
@cppalliance-bot
Copy link

An automated preview of the documentation is available at https://478.mrdox.prtest2.cppalliance.org/index.html

@cppalliance-bot
Copy link

An automated preview of the documentation is available at https://478.mrdox.prtest2.cppalliance.org/index.html

@alandefreitas alandefreitas linked an issue Nov 3, 2023 that may be closed by this pull request
Wrong git tag in docs #462
Closed
@cppalliance-bot
Copy link

An automated preview of the documentation is available at https://478.mrdox.prtest2.cppalliance.org/index.html

@cppalliance-bot
Copy link

An automated preview of the documentation is available at https://478.mrdox.prtest2.cppalliance.org/index.html

sdkrystian
sdkrystian reviewed Nov 4, 2023
View reviewed changes
@alandefreitas
docs: LLVM version is 29b20829
7ab487e 
The old instructions referred to 731264b0 version of LLVM. The binaries on the website provided for users were updated to 29b20829 and the install instructions were updated to reflect the preset examples.

fix cppalliance#462
@alandefreitas
Copy link
Collaborator Author

@sdkrystian Changed. I found some middle ground for the presets issue by recommending presets and justifying it. Although I agree presets are always better, I kept the basics about the possibility of "classic mode" later in the section just to avoid hearing complaints, having long discussions, or even having to undo it.

@cppalliance-bot
Copy link

An automated preview of the documentation is available at https://478.mrdox.prtest2.cppalliance.org/index.html

@alandefreitas alandefreitas merged commit 6c6d641 into cppalliance:develop Nov 6, 2023
@alandefreitas alandefreitas deleted the update-docs branch June 24, 2024 23:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sdkrystian sdkrystian sdkrystian left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Wrong git tag in docs
3 participants
@alandefreitas @cppalliance-bot @sdkrystian