Skip to content

docs(project): add Catalog consolidations subsection to PROJECT/README.MD#27

Open
Adiz4415 wants to merge 6 commits into
Pi-Defi-world:mainfrom
Adiz4415:docs/project-readme-catalog-consolidations-refs
Open

docs(project): add Catalog consolidations subsection to PROJECT/README.MD#27
Adiz4415 wants to merge 6 commits into
Pi-Defi-world:mainfrom
Adiz4415:docs/project-readme-catalog-consolidations-refs

Conversation

@Adiz4415

Copy link
Copy Markdown
Contributor

Summary

Adds a "Catalog consolidations" subsection under the Project Management block of PROJECT/README.MD so contributors can quickly locate the durable long-form reference files for each domain catalog, with canonical entry counts, severity distributions, and links to the consolidation PRs (#22 contracts, #23 backend, #25 frontend).

What changed

  • PROJECT/README.MD — nested Catalog consolidations bullet block under the ### Project Management (\PROJECT/`)` subsection, immediately after the existing Known issues line, with three child bullets:
  • Footer Last Updated: date bumped from January 26, 2026June 20, 2026 to match the June catalog-consolidation PRs.

Adjacent quality-of-life fix (out of strict scope)

The pre-existing Known issues line above the new subsection used bare filenames (CONTRACTS_ISSUES.md, …) which resolved to non-existent files at PROJECT/CONTRACTS_ISSUES.md instead of the actual PROJECT/issues/CONTRACTS_ISSUES.md path. I corrected those three links to issues/CONTRACTS_ISSUES.md / issues/BACKEND_ISSUES.md / issues/FRONTEND_ISSUES.md so the whole block now links correctly. This is technically scope-creep relative to the user's stated add-only request, but it was a one-line drive-by and prevents the new subsection from sitting alongside three broken siblings. Flag in case the maintainer wants this split into a separate PR; happy to revert if preferred.

Verification

Adiz4415 added 6 commits June 20, 2026 12:25
…catalog

- Restructure PROJECT/issues/CONTRACTS_ISSUES.md into a single source of
  truth using canonical severity/area/evidence/impact/fix/acceptance format.
- Cover all 60 catalog entries from issues/contracts.md (Critical 6, High
  21, Medium 24, Low 9) with stable C-### IDs.
- Preserve the legacy 34-item list as Section 7 cross-reference.
- Add Summary Table, Severity Counts, Resolution Tracker, Top Remediations
  (ship-safety order), Cross-Reference Map, and Maintenance notes.
- Provide anchor points for future PR references.

Closes Pi-Defi-world#12
- Catalog sources & deduping section renames the prior Deduping section
  and explicitly elevates PROJECT/issues/CONTRACTS_ISSUES.md (PR Pi-Defi-world#22) and
  PROJECT/issues/BACKEND_ISSUES.md (PR Pi-Defi-world#23) to durable long-form references;
  FRONTEND_ISSUES.md remains legacy pending follow-up PR.
- Top 20 list gains per-item deep links to the Resolution Tracker
  (Section 8) of each consolidated catalog and uniformly bolds IDs.
- New CHANGELOG section appended in strict reverse-chronological order
  (this PR refresh first, then PR Pi-Defi-world#23 backend, then PR Pi-Defi-world#22 contracts,
  then future frontend consolidation).
…d 11 per-item tracker pointers

- Catalog sources & deduping elevates PROJECT/issues/FRONTEND_ISSUES.md
  to durable long-form reference (was legacy/\u2018pending follow-up\u2019), cited
  to PR Pi-Defi-world#25.
- Top 20 list gains per-item tracker pointers for the 11 user-listed
  frontend items: F-001/F-002/F-005 (Critical, wallet+auth) and
  F-014/F-015/F-019/F-020/F-022/F-025/F-051/F-063 (top-High ship-safety),
  mirroring the contracts/backend pointer pattern.
- CHANGELOG now in reverse-chronological order with Frontend PR Pi-Defi-world#25 at
  top; Master Index Refresh entry cites PR Pi-Defi-world#25 directly; legacy\n  \u2018_(Future) Frontend_\u2019 placeholder retired.
- F-004 (item 20) remains Critical in Top 20 without a per-item pointer\n  by design \u2014 not in user\u2019s explicit 11-set; CHANGELOG documents this so\n  it is addressable in a follow-up PR.
…E.MD

- New nested 'Catalog consolidations' block under Project Management
  subsection listing PROJECT/issues/CONTRACTS_ISSUES.md (PR Pi-Defi-world#22),
  PROJECT/issues/BACKEND_ISSUES.md (PR Pi-Defi-world#23), and
  PROJECT/issues/FRONTEND_ISSUES.md (PR Pi-Defi-world#25) as durable long-form
  references with canonical-entry counts and severity distributions.
- Corrected the adjacent pre-existing 'Known issues' line link paths
  from bare filenames to the working 'issues/...' form so the whole
  block is discoverable.
- Bumped footer 'Last Updated:' from 2026-01-26 to 2026-06-20 to match
  the June catalog-consolidation PR envelope.
@coderabbitai

coderabbitai Bot commented Jun 20, 2026

Copy link
Copy Markdown

Warning

Review limit reached

@Adiz4415, we couldn't start this review because you've reached your PR review rate limit.

More reviews will be available in 16 minutes and 29 seconds. Learn how PR review limits work.

Your organization has used up its prepaid credits, and credit purchases are no longer available. Enable the review add-on in the billing tab to keep reviews running — you're only billed for reviews past your plan's rate limits ($0.25/file).

⌛ How to resolve this issue?

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 credits.

🚦 How do rate limits work?

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

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, the refill rate gradually slows as usage increases. The highest same-day bursts are limited more strictly.

Please see our Fair Usage Limits Policy for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: cfe4058c-8108-48d2-bfff-83ff98227c5c

📥 Commits

Reviewing files that changed from the base of the PR and between ea8aa4b and be1333b.

📒 Files selected for processing (5)
  • PROJECT/README.MD
  • PROJECT/issues/BACKEND_ISSUES.md
  • PROJECT/issues/CONTRACTS_ISSUES.md
  • PROJECT/issues/FRONTEND_ISSUES.md
  • issues/MASTER_INDEX.md
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

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