Skip to content

cleanup: refresh public README and repo structure - #7

Merged
synqing merged 2 commits into
feat/mcp-rag-bootstrapfrom
cleanup/readme-licence-settings
Jul 12, 2026
Merged

cleanup: refresh public README and repo structure#7
synqing merged 2 commits into
feat/mcp-rag-bootstrapfrom
cleanup/readme-licence-settings

Conversation

@synqing

@synqing synqing commented Jul 12, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • Replaces the overclaiming root README with a conservative public README scoped to tooling, MCP servers, and preserved prototypes.
  • Adds Apache-2.0 LICENSE per the approved Stage 2 metadata ruling.
  • Moves loose root Python and shell prototype files into tools/elite-pcb-designer/legacy-pipeline/.
  • Removes duplicate root datasheet PDFs, tracked Python bytecode, and the remaining public product-design docs/BOM from HEAD under the existing accept-head-only sensitive-content ruling.

Validation

  • git diff --cached --check
  • root staged tree check: root files are .gitignore, LICENSE, README.md only
  • tracked bytecode count: 0
  • root .py/.sh/.pdf count: 0
  • sensitive doc path count for docs/prd, docs/bom, DESIGN_VALIDATION_SUMMARY, MANUFACTURING_PACKAGE, ERRATA_REV-A_VALIDATED: 0
  • LC_ALL=C grep for non-ASCII in README.md and LICENSE: no output
  • python3 -m py_compile for moved legacy-pipeline Python files
  • python3 -m unittest test_ipc_standards test_component_placement: 58 tests passed, 9 skipped; KiCad pcbnew missing warning expected in this environment

Known residual

  • python3 -m unittest test_ipc_standards test_component_placement test_elite_pcb_designer fails in test_elite_pcb_designer because the preserved legacy tests expect an older ElitePCBDesigner API. This is pre-existing prototype drift; this PR does not refactor that prototype.
  • docs/internal/legacy-root still needs content review before amplification. I did not delete that whole reference pile in this PR.

@coderabbitai

coderabbitai Bot commented Jul 12, 2026

Copy link
Copy Markdown

Warning

Review limit reached

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

Next review available in: 8 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: 3d2a6188-d1c0-4d2a-860f-9a49cf84129d

📥 Commits

Reviewing files that changed from the base of the PR and between 9e1a146 and 92a6121.

⛔ Files ignored due to path filters (13)
  • agent/__pycache__/__init__.cpython-312.pyc is excluded by !**/*.pyc
  • agent/configs/__pycache__/__init__.cpython-312.pyc is excluded by !**/*.pyc
  • agent/dfm/__pycache__/__init__.cpython-312.pyc is excluded by !**/*.pyc
  • agent/drivers/__pycache__/__init__.cpython-312.pyc is excluded by !**/*.pyc
  • agent/impedance/__pycache__/__init__.cpython-312.pyc is excluded by !**/*.pyc
  • agent/kicad/__pycache__/__init__.cpython-312.pyc is excluded by !**/*.pyc
  • agent/orchestrator/__pycache__/__init__.cpython-312.pyc is excluded by !**/*.pyc
  • agent/routing/__pycache__/__init__.cpython-312.pyc is excluded by !**/*.pyc
  • agent/thermal/__pycache__/__init__.cpython-312.pyc is excluded by !**/*.pyc
  • docs/bom/K1_Lightwave_RevA_LCSC_Default.csv is excluded by !**/*.csv
  • esp-hardware-design-guidelines-en-master-esp32s3.pdf is excluded by !**/*.pdf
  • esp32-s3_datasheet_en.pdf is excluded by !**/*.pdf
  • mcp/mcp-rag/__pycache__/server.cpython-312.pyc is excluded by !**/*.pyc
📒 Files selected for processing (35)
  • .github/workflows/kibot.yml
  • LICENSE
  • README.md
  • docs/DESIGN_VALIDATION_SUMMARY.md
  • docs/ERRATA_REV-A_VALIDATED.md
  • docs/MANUFACTURING_PACKAGE.md
  • docs/prd/01-product-brief.md
  • docs/prd/02-hardware-prd.md
  • docs/prd/03-validation-plan.md
  • tools/elite-pcb-designer/legacy-pipeline/automated_routing.py
  • tools/elite-pcb-designer/legacy-pipeline/component_placement.py
  • tools/elite-pcb-designer/legacy-pipeline/demo_elite_pcb_designer.py
  • tools/elite-pcb-designer/legacy-pipeline/demo_placement.py
  • tools/elite-pcb-designer/legacy-pipeline/design_preparation.py
  • tools/elite-pcb-designer/legacy-pipeline/design_validation.py
  • tools/elite-pcb-designer/legacy-pipeline/elite_pcb_designer.py
  • tools/elite-pcb-designer/legacy-pipeline/elite_pcb_designer_cli.py
  • tools/elite-pcb-designer/legacy-pipeline/example_k1_full_design.py
  • tools/elite-pcb-designer/legacy-pipeline/example_k1_routing.py
  • tools/elite-pcb-designer/legacy-pipeline/freerouting_config.py
  • tools/elite-pcb-designer/legacy-pipeline/ipc_standards_library.py
  • tools/elite-pcb-designer/legacy-pipeline/k1_board_automation_template.py
  • tools/elite-pcb-designer/legacy-pipeline/populate_board_from_netlist.py
  • tools/elite-pcb-designer/legacy-pipeline/populate_board_manual.py
  • tools/elite-pcb-designer/legacy-pipeline/run_elite_designer.py
  • tools/elite-pcb-designer/legacy-pipeline/run_placement_demo.sh
  • tools/elite-pcb-designer/legacy-pipeline/run_placement_test.sh
  • tools/elite-pcb-designer/legacy-pipeline/test_automated_routing.py
  • tools/elite-pcb-designer/legacy-pipeline/test_component_placement.py
  • tools/elite-pcb-designer/legacy-pipeline/test_design_preparation.py
  • tools/elite-pcb-designer/legacy-pipeline/test_design_validation.py
  • tools/elite-pcb-designer/legacy-pipeline/test_elite_pcb_designer.py
  • tools/elite-pcb-designer/legacy-pipeline/test_ipc_standards.py
  • tools/elite-pcb-designer/legacy-pipeline/validate_k1_lightwave.py
  • tools/elite-pcb-designer/legacy-pipeline/validation_report_template.py
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch cleanup/readme-licence-settings

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.

The public cleanup removed hardware/k1-lightwave, so the KiBot fab workflow now points at a non-existent private design tree.

Signed-off-by: K1 Lightwave Hardware <hardware@k1lightwave.local>
@synqing
synqing merged commit 54d2eed into feat/mcp-rag-bootstrap Jul 12, 2026
1 check passed
@synqing
synqing deleted the cleanup/readme-licence-settings branch July 12, 2026 11:23
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