Update installation instructions for CMake #270
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
To test, I ran `au-docs-serve`, and did an A/B comparison with respect to the currently deployed doc website. Looks like the table got updated correctly, the tabbed instructions work, and everything else was as expected. Fixes #215.
chiphogg
added
the
release notes: 📝 documentation
geoffviola
approved these changes
Jul 22, 2024
docs/install.md
Outdated
| all_verify_interface_header_sets \ | ||
| test | ||
| ``` | ||
| The reason we recommend `FetchContent` is because it makes it easier for each project to get the |
There was a problem hiding this comment.
This wording is a little clunky. It might be clearer to write something like
We recommend `FetchContent` because it gets the exact version and installs au for the project.
There was a problem hiding this comment.
I tweaked it a little bit based on your recommendation.
docs/install.md
Outdated
| We would like to support all these build and packaging systems, and perhaps others! But the initial | ||
| public release is bazel-only, because bazel is what we use at Aurora, and we don't have experience | ||
| with any of these alternatives. Thus, we'll need to lean on the community to support them. | ||
| Now, here are the installation instructions. |
There was a problem hiding this comment.
I don't like the word Now and these are all installation instructions. It might be better to delete this line.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
To test, I ran
au-docs-serve, and did an A/B comparison with respectto the currently deployed doc website. Looks like the table got updated
correctly, the tabbed instructions work, and everything else was as
expected.
Fixes #215.