Skip to content
This repository was archived by the owner on Feb 16, 2026. It is now read-only.

Update example asset links in README.md#425

Merged
jpeiffer merged 1 commit into
peiffer-innovations:mainfrom
aktxyz:patch-8
Jan 12, 2026
Merged

Update example asset links in README.md#425
jpeiffer merged 1 commit into
peiffer-innovations:mainfrom
aktxyz:patch-8

Conversation

@aktxyz

@aktxyz aktxyz commented Dec 30, 2025

Copy link
Copy Markdown
Contributor

Looks like the links in these docs are all pointing to the old location for the example json assets !

Summary by CodeRabbit

  • Documentation
    • Updated all documentation links and navigation paths to reflect the new examples structure throughout the README.
    • Widget example references in the Built In Widgets table, including align, animated containers, and other components, now point to the updated location.
    • Enhanced formatting in the Arg Processor section for better readability.

✏️ Tip: You can customize this high-level summary in your review settings.

Looks like the links in these docs are all pointing to the old location for the example json assets !
@coderabbitai

coderabbitai Bot commented Dec 30, 2025

Copy link
Copy Markdown

Walkthrough

Documentation update redirecting widget example asset paths from the original package-oriented directory structure to a new examples-based structure. All references in the Built In Widgets table and the null value passing example link are updated to reflect the new asset location. Minor formatting adjustment in the Arg Processor section.

Changes

Cohort / File(s) Summary
Documentation asset path migration
packages/json_dynamic_widget/README.md
Updated all widget example references in the Built In Widgets table from packages/json_dynamic_widget/example/assets/pages/... to examples/json_dynamic_widget_example/assets/pages/... (affects align.json, animated_align.json, animated_container.json, and all other widget examples). Updated null_value_passing.json example link to new path. Formatting adjustment in Arg Processor section.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Pre-merge checks

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the main change: updating example asset links in README.md from old package paths to new examples-based paths.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

📜 Recent review details

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 0b95d42 and 3dd1547.

📒 Files selected for processing (1)
  • packages/json_dynamic_widget/README.md
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
  • GitHub Check: build
🔇 Additional comments (3)
packages/json_dynamic_widget/README.md (3)

515-515: null_value_passing.json example file exists at the specified location.

The file null_value_passing.json is correctly located at examples/json_dynamic_widget_example/assets/pages/null_value_passing.json, confirming the updated link in the README is accurate.


381-478: README link migration verified successfully.

All 60 unique example files referenced in the Built In Widgets table exist at the new examples/json_dynamic_widget_example/assets/pages/ paths. No old path references remain in the documentation, and all links are correctly formatted. The comprehensive update is complete with no broken links.


540-540: Verify if variables.json example link needs updating.

Line 540 references example/assets/pages/variables.json, which may use the old path structure. Check whether this link should be updated to match the new examples/json_dynamic_widget_example/assets/pages/ structure if other example links in the document were changed during this PR. If the file exists at the new location, update the reference; if it remains only at the old location, verify the link is still valid.


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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@jpeiffer jpeiffer left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@jpeiffer jpeiffer merged commit 2c6e94c into peiffer-innovations:main Jan 12, 2026
3 checks passed
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants