docs: add underlying#2297
Open
jdegand wants to merge 1 commit into
Open
Conversation
Contributor
📝 WalkthroughWalkthroughA single bullet entry for ChangesREADME Animations Entry
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@README.md`:
- Line 1227: Remove or relabel the underlying entry in the README
Angular-specific list, since the repository does not contain an Angular package
or Angular usage docs for it. Update the README entry near the existing
underlying link to either omit it from the Angular list or clearly mark it as
framework-agnostic/planned rather than Angular-specific, using the underlying
package name as the reference point.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
| * [ng-motion](https://github.com/ScriptType/ng-motion) - Angular animation library built on [motion-dom](https://github.com/motiondivision/motion). | ||
| * [ngx-digit-flow](https://github.com/ayangabryl/ngx-digit-flow) - Individual digit animations for Angular. Each digit has a vertical reel (0-9) that scrolls to the new value when the number changes - slot-machine / odometer style. | ||
| * [angular-movement](https://github.com/Andersseen/angular-movement) - An Angular motion ecosystem combining a reusable animation‑directive library with a demo and documentation site in one repository. | ||
| * [underlying](https://github.com/underlyingjs/underlying) - Declarative, framework‑agnostic, TypeScript‑native, physics‑first animation library for the web. |
Contributor
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
# Verify repository exists and check for Angular-related content
curl -s -o /dev/null -w "%{http_code}" https://github.com/underlyingjs/underlying
echo ""
# Search for Angular mentions in the repo if accessible
curl -s https://raw.githubusercontent.com/underlyingjs/underlying/main/README.md | rg -i 'angular' || echo "No Angular mentions found in main README"Repository: PatrickJS/awesome-angular
Length of output: 246
🏁 Script executed:
#!/bin/bash
set -euo pipefail
repo='underlyingjs/underlying'
base="https://raw.githubusercontent.com/${repo}/main"
echo "== README Angular mentions =="
curl -fsSL "${base}/README.md" | rg -n -i 'angular|`@underlying/angular`' || true
echo
echo "== package / workspace files mentioning Angular =="
for path in \
package.json \
pnpm-workspace.yaml \
turbo.json \
nx.json \
packages/angular/package.json \
libs/angular/package.json \
angular/package.json
do
url="${base}/${path}"
if curl -fsSL "$url" >/tmp/underlying_check 2>/dev/null; then
echo "-- ${path}"
rg -n -i 'angular|`@underlying/angular`' /tmp/underlying_check || true
fi
done
echo
echo "== README lines around Angular row =="
curl -fsSL "${base}/README.md" | nl -ba | sed -n '1,220p' | rg -n 'angular|underlying' -A2 -B2 || trueRepository: PatrickJS/awesome-angular
Length of output: 491
🏁 Script executed:
#!/bin/bash
set -euo pipefail
repo='underlyingjs/underlying'
base="https://raw.githubusercontent.com/${repo}/main"
for path in package.json pnpm-workspace.yaml README.md packages/angular/package.json libs/angular/package.json angular/package.json; do
url="${base}/${path}"
echo "== ${path} =="
if content=$(curl -fsSL "$url" 2>/dev/null); then
printf '%s\n' "$content" | sed -n '1,220p'
else
echo "unavailable"
fi
echo
doneRepository: PatrickJS/awesome-angular
Length of output: 8310
🏁 Script executed:
#!/bin/bash
set -euo pipefail
repo='underlyingjs/underlying'
api="https://api.github.com/repos/${repo}/git/trees/main?recursive=1"
curl -fsSL "$api" | python3 - <<'PY'
import json, sys
data = json.load(sys.stdin)
for item in data.get("tree", []):
path = item.get("path", "")
if "angular" in path.lower() or path in ("package.json", "pnpm-workspace.yaml", "README.md"):
print(path)
PYRepository: PatrickJS/awesome-angular
Length of output: 933
🏁 Script executed:
#!/bin/bash
set -euo pipefail
repo='underlyingjs/underlying'
api="https://api.github.com/repos/${repo}/git/trees/main?recursive=1"
tmp="$(mktemp)"
curl -fsSL "$api" -o "$tmp"
python3 - <<'PY' < "$tmp"
import json, sys
data = json.load(sys.stdin)
paths = [item.get("path", "") for item in data.get("tree", [])]
for p in paths:
if "angular" in p.lower() or p in ("README.md", "package.json", "pnpm-workspace.yaml"):
print(p)
PYRepository: PatrickJS/awesome-angular
Length of output: 302
🏁 Script executed:
#!/bin/bash
set -euo pipefail
repo='underlyingjs/underlying'
api="https://api.github.com/repos/${repo}/git/trees/main?recursive=1"
tmp="$(mktemp)"
curl -fsSL "$api" -o "$tmp"
python3 - "$tmp" <<'PY'
import json, sys
data = json.load(open(sys.argv[1]))
paths = [item["path"] for item in data.get("tree", []) if "angular" in item["path"].lower()]
for p in paths:
print(p)
PYRepository: PatrickJS/awesome-angular
Length of output: 163
Drop or relabel this entry (README.md:1227)
underlying is framework-agnostic, and the only Angular reference is a planned @underlying/angular package; there’s no Angular package or usage docs in the repo. It doesn’t belong in an Angular-specific list yet.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@README.md` at line 1227, Remove or relabel the underlying entry in the README
Angular-specific list, since the repository does not contain an Angular package
or Angular usage docs for it. Update the README entry near the existing
underlying link to either omit it from the Angular list or clearly mark it as
framework-agnostic/planned rather than Angular-specific, using the underlying
package name as the reference point.
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
1 participant
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.
Summary by CodeRabbit