Add README files for many packages #4766
Open
Conversation
This file contains hidden or 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
theunrepentantgeek
requested review from
davefellows and
matthchr
as code owners
github-project-automation
bot
moved this to In Progress
in Azure Service Operator Roadmap
theunrepentantgeek
force-pushed
the
feature/package-docs
branch
from
6c27758 to
9c6d9e0
Compare
theunrepentantgeek
force-pushed
the
feature/package-docs
branch
from
96a6d3a to
074bcd4
Compare
matthchr
reviewed
Jun 12, 2025
| @@ -0,0 +1,49 @@ | |||
| # Genruntime Package | |||
There was a problem hiding this comment.
There's a standard with doc.go (see https://go.dev/blog/godoc) -- maybe we should be using that rather than PACKAGE.md?
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.
What this PR does
I've long wanted to write an overview README for most of our packages, as a way to give new contributors a quick lay of the land when they start reading code and working out where to make their changes.
I've used GitHub CoPilot to write these, with a manual review pass for accuracy and clarity.
Special notes
Docs are driven by the
package-documentation.instructionsHow does this PR make you feel?
Checklist