Skip to content

docs(P4): update README.md to remove UTF-8 characters and add failure cases doc link - #13

Merged
DsThakurRawat merged 1 commit into
mainfrom
phase-4-readme-update-2
Jul 10, 2026
Merged

docs(P4): update README.md to remove UTF-8 characters and add failure cases doc link#13
DsThakurRawat merged 1 commit into
mainfrom
phase-4-readme-update-2

Conversation

@DsThakurRawat

Copy link
Copy Markdown
Owner

Updates README.md to be completely ASCII (removes all Unicode symbols/dashes) and adds a link to docs/failure_cases.md.

@beetle-ai

beetle-ai Bot commented Jul 10, 2026

Copy link
Copy Markdown

Important

Review skipped

You've hit the daily PR analysis limit on your current plan. Consider upgrading: Upgrade

⚙️ Settings

Severity Threshold: Medium — Balanced feedback — medium and high severity issues only.Change in Settings
Custom Rules: Define your own review rules — Set Custom Rules
PR Summary: Configure PR summary — Change in Settings

📖 User Guide
  • Once repos are connected, PR analysis is automatically enabled. You can disable analysis for this repo from beetleai.dev/analysis
  • Comment @beetle on any PR to start analysis manually
  • Comment @beetle stop to stop any ongoing analysis

Follow us: Beetle · X · LinkedIn

@DsThakurRawat
DsThakurRawat merged commit ceb70d2 into main Jul 10, 2026
1 check passed
@coderabbitai

coderabbitai Bot commented Jul 10, 2026

Copy link
Copy Markdown

Warning

Review limit reached

@DsThakurRawat, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 24 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: ed8f15d5-57a1-4432-8117-48c18028ef4e

📥 Commits

Reviewing files that changed from the base of the PR and between 48afbcd and 791cbf7.

📒 Files selected for processing (1)
  • README.md
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch phase-4-readme-update-2

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.

@DsThakurRawat
DsThakurRawat deleted the phase-4-readme-update-2 branch July 10, 2026 16:18

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Code Review

This pull request simplifies and restructures the README.md file to make it more concise, updating the installation and quickstart instructions, and moving detailed experimental results to external documentation. The reviewer noted an inconsistency in the documented output filenames between README.md and implementation.md, which should be standardized.

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

Comment thread README.md
---

## S3DIS Area-5 Evaluation and Experiments
Each run writes to `outputs/`: `segmented_room.ply` (labeled cloud), `segmentation_report.json` (validated cluster report), and `segmentation_viz.png` (2D semantic map).

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

medium

There is an inconsistency in the output filenames documented across different files:\n\n- README.md (lines 43, 46) and PIPELINE.md (lines 61-63) refer to segmented_room.ply, segmentation_report.json, and segmentation_viz.png.\n- implementation.md (lines 700, 874-875, 1013-1015) refers to segmented.ply, report.json, and topdown_map.png.\n\nPlease standardize these filenames across all documentation files to ensure consistency and avoid confusion for users running the pipeline.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant