docs: improve developer documentation for folks new to the codebase #2576
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
* cmake is not used for building debugd anymore, remove references to it * make the debug-cluster workflow the authoritative source for cdbg usage - don't replicate the same instructions in different places
4 tasks
✅ Deploy Preview for constellation-docs canceled.
|
malt3
approved these changes
Nov 13, 2023
There was a problem hiding this comment.
Thank you for improving the documentation!
Some style / workflow nits:
You should be allowlisted to create branches on the org repo (you don't need to use a fork).
Also unless you plan to squash the commits in this PR, we tend to follow the PR title scheme also for the first line in each commit message.
|
Thanks for the review! This PR is indeed from an org repo branch, the forked one was #2559. Ack on the commit style, I'm going to squash. |
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.
Context
I used the docs for onboarding and took note of things that might need clarification or fixing. This PR addresses these findings.
Proposed change(s)
debug-cluster.mdAdditional info
Replaces #2559
Checklist