docs: add missing packages and proxy mode to CONTRIBUTING.md#2957
Merged
Conversation
Add 5 missing internal packages to the project structure tree and Key Directories list: proxy/, httputil/, oidc/, strutil/, syncutil/. Add HTTP forward proxy mode and OIDC auth to the Core Features list. Closes #2905 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Updates contributor documentation to match the repository’s current internal package layout and feature set, addressing discrepancies found by the nightly docs reconciler (Issue #2905).
Changes:
- Adds missing internal packages (
httputil,oidc,proxy,strutil,syncutil) to the Project Structure tree and Key Directories list. - Updates Architecture Notes → Core Features to mention HTTP forward proxy mode (
awmg proxy) and OIDC authentication.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This was referenced Mar 31, 2026
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
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.
Problem
Nightly Documentation Reconciler (#2905) found 2 discrepancies in CONTRIBUTING.md:
Project structure missing 5 packages —
internal/proxy/,internal/httputil/,internal/oidc/,internal/strutil/, andinternal/syncutil/exist in the codebase but were not listed in the project structure tree or Key Directories section.Core Features missing proxy mode — The
awmg proxysubcommand is a major feature with its own reference doc (docs/PROXY_MODE.md) but was not mentioned in the Architecture Notes.Fix
awmg proxy) to Core FeaturesCloses #2905