docs(README.md): add build artifact section; add TOC #187
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
Contributor
vdice
commented
Sep 12, 2024
vdice
commented
- Adds a section describing which build artifacts are produced for what events
- Adds a TOC at the top of the README for easier navigation
vdice
requested review from
Mossaka,
kate-goldenring,
jsturtevant,
radu-matei and
devigned
as code owners
vdice
force-pushed
the
docs/build-artifacts-and-toc
branch
from
317112d
to
044601b
Compare
kate-goldenring
approved these changes
Sep 12, 2024
There was a problem hiding this comment.
Thank you for adding this @vdice. There is strange red error highlighting that i am seeing. It might be fine to ignore but a quick search shows it may be a syntax error GitHub is picking up
Mossaka
approved these changes
Sep 13, 2024
vdice
force-pushed
the
docs/build-artifacts-and-toc
branch
from
044601b
to
096abb7
Compare
|
@kate-goldenring I think we can ignore; I'm not sure why the red syntax highlighting is occurring. The preview looks fine. |
Signed-off-by: Vaughn Dice <[email protected]>
vdice
force-pushed
the
docs/build-artifacts-and-toc
branch
from
096abb7
to
2c1a48a
Compare
|
Updated the wording a bit with the last push; feel free to merge when ready! |
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.