Skip to content

clean up old README#376

Merged
imor merged 2 commits intomasterfrom
docs/cleanup
Mar 4, 2026
Merged

clean up old README#376
imor merged 2 commits intomasterfrom
docs/cleanup

Conversation

@kiwicopple
Copy link
Member

No description provided.

@vercel
Copy link

vercel bot commented Mar 4, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
dbdev Ready Ready Preview, Comment Mar 4, 2026 10:31am

Request Review

@coderabbitai
Copy link

coderabbitai bot commented Mar 4, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Central YAML (base), Organization UI (inherited)

Review profile: CHILL

Plan: Pro

Run ID: 0ae09f61-0918-4ab1-8074-7bd16e93f20b

📥 Commits

Reviewing files that changed from the base of the PR and between c724636 and 5e64de4.

📒 Files selected for processing (1)
  • README.md
🚧 Files skipped from review as they are similar to previous changes (1)
  • README.md

📝 Walkthrough

Summary by CodeRabbit

  • Documentation
    • Added a new contributor guide covering developer setup, prerequisites, local service commands, environment configuration, and registry/website workflows.
    • Removed a former upgrade planning document that outlined migration steps and timelines.
    • Restructured the README to add a Trusted Language Extensions overview, consolidate external reference links, and include licensing information.

Walkthrough

This pull request reorganizes the repository's documentation. A new CONTRIBUTING.md file is added, providing comprehensive developer setup instructions including package registry workflow, website setup using Next.js, prerequisite tools, environment configuration, and local development commands. The existing PLAN.md file is deleted entirely, which contained a detailed multi-phase upgrade plan for migrating to Next.js 16.x and updating component patterns. The README.md is restructured, removing extensive usage and installation sections while adding a new "Links" section with external references, a "What is a Trusted Language Extension?" section, and a "Licence" section.


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.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@README.md`:
- Line 20: The README.md file ends without a normalized newline, causing the
End-of-File Fixer hook to modify it; open README.md, add a final newline at the
end of the file (ensure line with "Apache 2.0" is terminated), then run
`pre-commit run --all-files` (or re-save to let your editor normalize EOF) and
commit the updated README.md so CI no longer fails.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Central YAML (base), Organization UI (inherited)

Review profile: CHILL

Plan: Pro

Run ID: c1eb790f-62c1-4d4c-b3a8-4db7dc53765a

📥 Commits

Reviewing files that changed from the base of the PR and between fe786d0 and c724636.

📒 Files selected for processing (3)
  • CONTRIBUTING.md
  • PLAN.md
  • README.md
💤 Files with no reviewable changes (1)
  • PLAN.md

@imor imor merged commit 335a3ed into master Mar 4, 2026
8 checks passed
@imor imor deleted the docs/cleanup branch March 4, 2026 10:35
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.

2 participants