You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
docs: show proxy.conf.json in the client-only setup steps - #454
In Client-only Angular CLI app, the "Add the proxy config" step said "Save the proxy.conf.json above". The file was only in the last tab ("Client-only Angular CLI") of the server-part code group, about 35 lines earlier, behind the Express tab that is open by default. Someone reading the steps had nothing to save.
The step now says "below", and the section shows the same proxy.conf.json right after the steps, next to the existing angular.json excerpt. The tab stays as it is.
The config is the one pnpm e2e:install uses for the angular-cli-nossr scenario (target, pathRewrite and ws on /__pangular).
pnpm docs:build passes (link and anchor guards); the built page has the JSON both in the tab and in the section
Notes for reviewers
#445 (--proxy-origin is an unknown option) isn't a docs typo. The flag is on main (since #363), but npm's latest is still 0.0.7 from Oct 5, which predates it, and the docs site follows main. It needs a release, or a note that the docs describe the next one.
Updated the client-only Angular CLI instructions to place the proxy configuration example in the relevant workflow and clarify that it should be saved next to angular.json.
Changed the instructions to refer to the proxy configuration as being “below.”
Review was skipped as selected files did not have any reviewable changes.
Run configuration
Source mode: Auto
Repository: Unavailable
Branch: Unavailable
File: No configuration file from this repository applied
Commit: Unavailable
Layers: defaults
Review profile: CHILL
Plan: Advanced
Run ID: 8e1bd4c1-6fe9-459f-8e01-e888113b6cbf
Commits
Reviewing files that changed from the base of the PR and between 9723b5c and 17e6653.
You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.
Use the checkbox below for a quick retry:
Trigger review
No actionable comments were generated in the recent review.
Walkthrough
The installation guide now includes the proxy.conf.json example in the client-only Angular CLI workflow. It updates the instruction to refer to the example below.
The workflow instruction now points to the proxy configuration below. The example forwards /__pangular to http://localhost:9999, strips the prefix, and enables WebSocket forwarding.
pangular-inspector/devtools#445: The change adds the missing proxy.conf.json example. It does not address the separate --proxy-origin option failure.
Suggested labels:area: docs
Merge Risk: Minimal · previous review 9723b
This documentation change adds the missing proxy.conf.json example to the client-only Angular CLI setup. The example matches the configuration used by the e2e install scenario, so there is no merge-blocking concern.
Pre-merge checks: 5
Check name
Status
Explanation
Description Check
Check skipped - CodeRabbit’s high-level summary is enabled.
Title check
The title "docs: show proxy.conf.json in the client-only setup steps" matches the main change. The PR moves the proxy.conf.json example into the client-only Angular CLI setup steps, and the raw summar…
Linked Issues check
Issue #446 reports that the Client-only Angular CLI steps say to save the proxy.conf.json "above", but the file is not provided in that section. The reviewed diff of `apps/docs/src/content/getting-s…
Out of Scope Changes check
The whole-PR diff against the merge base changes one file, apps/docs/src/content/getting-started/installation.md. The changes are: (1) the word "above" becomes "below" in the Client-only Angular CLI…
Docstring Coverage
No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentat…
Full details: Title check
Explanation
The title "docs: show proxy.conf.json in the client-only setup steps" matches the main change. The PR moves the proxy.conf.json example into the client-only Angular CLI setup steps, and the raw summary confirms the file is now introduced beside angular.json in that workflow. The title is concise, specific, and follows the conventional commit style used for a docs change. It does not cover the wording change from "above" to "below", which is expected for a short title.
Full details: Linked Issues check
Explanation
Issue #446 reports that the Client-only Angular CLI steps say to save the proxy.conf.json "above", but the file is not provided in that section. The reviewed diff of apps/docs/src/content/getting-started/installation.md changes the step text from "above" to "below". It also adds a proxy.conf.json code block after the ngmd-workflow steps and before the angular.json excerpt. The block sets /__pangular with targethttp://localhost:9999, pathRewrite{"^/__pangular": ""}, and ws: true. This makes the file available at the point where the steps refer to it, which is the only requirement in #446. The issue has no other acceptance criteria. The diff does not touch the tabbed server-part code group, so that tab is unchanged. The raw summary says the example was "moved", but the diff shows an addition (+13/-1). The tab content remains, so the wording in the summary is inaccurate. The diff alone does not show that the new JSON matches the tab JSON or the e2e scenario. That match is not a requirement of #446, so it does not change this result. The change is documentation only. No coding requirement beyond the docs content exists in #446.
Full details: Out of Scope Changes check
Explanation
The whole-PR diff against the merge base changes one file, apps/docs/src/content/getting-started/installation.md. The changes are: (1) the word "above" becomes "below" in the Client-only Angular CLI "Add the proxy config" step, and (2) a proxy.conf.json code block is added beside the existing angular.json excerpt. Both changes implement #446 directly. No unrelated files or hunks appear in the diff. The PR description mentions #445 (--proxy-origin unknown option). That issue is not linked to this PR and the PR does not change code for it. The PR description states that #445 needs a release or a docs note. No out-of-scope change is present.
Full details: Docstring Coverage
Explanation
No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentation-only edits and deletions within surviving functions are included; unchanged diff context and fully deleted functions are excluded. Analyzed 0 functions across 0 files. (1 skipped: 1 unsupported.)
Finishing Touches
Generate unit tests (beta)
Commit to this branch
Create a new PR
Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.
Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.
The "Add the proxy config" step said "Save the proxy.conf.json above",
but the file was only in the last tab of the server-part code group,
behind the Express tab and in another section. The steps now point to a
copy of it right below them, next to the angular.json excerpt.
Fixes#446
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
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 and why
In Client-only Angular CLI app, the "Add the proxy config" step said "Save the
proxy.conf.jsonabove". The file was only in the last tab ("Client-only Angular CLI") of the server-part code group, about 35 lines earlier, behind the Express tab that is open by default. Someone reading the steps had nothing to save.The step now says "below", and the section shows the same
proxy.conf.jsonright after the steps, next to the existingangular.jsonexcerpt. The tab stays as it is.The config is the one
pnpm e2e:installuses for theangular-cli-nossrscenario (target,pathRewriteandwson/__pangular).Fixes #446
How it was verified
pnpm commit:checkpnpm format:checkpnpm docs:buildpasses (link and anchor guards); the built page has the JSON both in the tab and in the sectionNotes for reviewers
#445 (
--proxy-originis an unknown option) isn't a docs typo. The flag is onmain(since #363), but npm's latest is still 0.0.7 from Oct 5, which predates it, and the docs site followsmain. It needs a release, or a note that the docs describe the next one.Generated by Claude Code
Summary by CodeRabbit
angular.json.