Skip to content

docs: prune stale docs and align README#59

Merged
vansour merged 2 commits intomainfrom
docs/prune-stale-docs
Apr 26, 2026
Merged

docs: prune stale docs and align README#59
vansour merged 2 commits intomainfrom
docs/prune-stale-docs

Conversation

@vansour
Copy link
Copy Markdown
Owner

@vansour vansour commented Apr 26, 2026

Summary

  • remove archived phase docs, one-off release notes, and the obsolete run-http3-phase0.sh entrypoint
  • rewrite the main README and docs index so they only describe the current repository shape and active governance docs
  • simplify release note generation and remove stale control-plane wording from remaining scripts

Verification

  • bash -n scripts/run-http3-gate.sh scripts/run-http3-release-gate.sh scripts/install.sh scripts/prepare-release.sh
  • python3 scripts/run-modularization-gate.py
  • git diff --check

Copilot AI review requested due to automatic review settings April 26, 2026 11:13
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Apr 26, 2026

Warning

Rate limit exceeded

@vansour has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 54 minutes and 37 seconds before requesting another review.

Your organization is not enrolled in usage-based pricing. Contact your admin to enable usage-based pricing to continue reviews beyond the rate limit, or try again in 54 minutes and 37 seconds.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Repository UI (base), Organization UI (inherited)

Review profile: ASSERTIVE

Plan: Pro

Run ID: 46dd8b87-e776-4f0c-bc02-f9dafc53f452

📥 Commits

Reviewing files that changed from the base of the PR and between 46a555e and bf8b8c6.

📒 Files selected for processing (1)
  • README.md
📝 Walkthrough

Walkthrough

该PR进行了大规模文档整理和工作流调整:删除了HTTP/3阶段规划相关的多个文档文件,移除了发布流程中的每个标签自定义说明支持,更新README以反映新的平台信息和命令,并调整了模块化相关文档。

Changes

Cohort / File(s) Summary
Release Workflow
.github/workflows/release.yml
移除每个标签自定义说明文件(RELEASE_NOTES_${TAG}.md)的复制步骤和条件逻辑,简化发布说明生成流程。
HTTP/3 Architecture Documentation (Deletion)
docs/ARCHITECTURE_UPSTREAM_HTTP3_PHASE0_BASELINE.md, docs/ARCHITECTURE_UPSTREAM_HTTP3_PRODUCTION_PLAN.md, docs/HTTP3_PHASE0_BASELINE.md, docs/HTTP3_PHASE7_RELEASE.md, RELEASE_NOTES_v0.1.3-rc.13.md
完整删除HTTP/3阶段计划、基线定义、生产就绪规划和发布门控相关文档。
Modularization Documentation
docs/ARCHITECTURE_CODEBASE_MODULARIZATION_PLAN.md, docs/ARCHITECTURE_CODEBASE_MODULARIZATION_POLICY.md
删除分阶段模块化计划文档;更新策略文档,移除对已删除计划的链接,明确当前基线为空,拓展嵌入式测试模块的约束规则。
Documentation Updates
README.md, docs/ARCHITECTURE_MODULE_LAYOUT_GUIDE.md, docs/README.md
更新README以定位rginx为边缘Linux反向代理、添加新的"平台与交付"部分、扩展本地命令列表和安装说明;更新模块布局指南移除"阶段7"引用;重构docs索引以移除已删除文档并更新治理指导。
Script Changes
scripts/run-http3-gate.sh, scripts/run-http3-phase0.sh, scripts/run-http3-release-gate.sh
删除HTTP/3阶段0脚本,更新gate脚本的标签文本从"控制平面"改为"运行时检查命令",移除release-gate脚本中的"阶段7"引用。

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

Possibly related PRs

  • fix: restore docker packaging docs for releases #48:两个PR都修改了GitHub发布工作流(.github/workflows/release.yml);该PR恢复打包文档和Docker发布路径,而此PR修改了发布说明生成步骤并移除了每个标签的自定义说明处理。

Poem

🐰 清理归档旧计划,HTTP/3 的路已明,
删除过时的蓝图,工作流更简洁轻盈,
文档如叶落又起,模块化的心再次飞扬,
rginx 边缘守护者,整装待发向更远方~ 🚀

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed 标题清晰准确地概括了此拉取请求的主要变化:删除陈旧文档并对齐README。
Description check ✅ Passed 描述与变更集完全相关,详细说明了移除存档阶段文档、更新README和简化发布说明生成的内容。
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/prune-stale-docs

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
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR removes archived / one-off documentation and aligns the repository’s README + docs index to reflect the current “single-binary” project shape, while simplifying the GitHub Release body generation.

Changes:

  • Prune stale HTTP/3 phase/alignment docs, upstream HTTP/3 plan docs, an old curated release notes file, and the obsolete run-http3-phase0.sh script.
  • Rewrite README.md and docs/README.md to only describe current repository structure and active, long-lived governance docs.
  • Simplify .github/workflows/release.yml release-body generation by dropping the optional curated RELEASE_NOTES_<tag>.md prepend behavior.

Reviewed changes

Copilot reviewed 15 out of 15 changed files in this pull request and generated no comments.

Show a summary per file
File Description
scripts/run-http3-release-gate.sh Updates usage text to remove phase-specific wording while keeping current gate behavior unchanged.
scripts/run-http3-phase0.sh Removes obsolete phase-0 baseline runner entrypoint.
scripts/run-http3-gate.sh Updates admin test label wording to remove stale “control plane” phrasing.
docs/README.md Rewrites docs index to only list active, long-lived governance documentation.
docs/HTTP3_PHASE7_RELEASE.md Removes archived phase-7 release-gate doc.
docs/HTTP3_PHASE0_BASELINE.md Removes archived phase-0 baseline doc.
docs/ARCHITECTURE_UPSTREAM_HTTP3_PRODUCTION_PLAN.md Removes completed upstream HTTP/3 plan doc.
docs/ARCHITECTURE_UPSTREAM_HTTP3_PHASE0_BASELINE.md Removes archived upstream phase-0 baseline doc.
docs/ARCHITECTURE_MODULE_LAYOUT_GUIDE.md Removes phase-specific wording to make the guide timeless.
docs/ARCHITECTURE_HTTP3_NGINX_ALIGNMENT_PLAN.md Removes completed HTTP/3 alignment plan doc.
docs/ARCHITECTURE_CODEBASE_MODULARIZATION_POLICY.md Updates policy wording to stand alone (no longer framed as “plan phase 0”) and clarifies baseline file semantics.
docs/ARCHITECTURE_CODEBASE_MODULARIZATION_PLAN.md Removes completed modularization plan doc.
RELEASE_NOTES_v0.1.3-rc.13.md Removes one-off curated release notes file.
README.md Aligns top-level README to current repo shape, adds install instructions, and refreshes command/examples and docs links.
.github/workflows/release.yml Simplifies release body generation and renames the step to match output (“Release Body”).

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

coderabbitai[bot]
coderabbitai Bot previously requested changes Apr 26, 2026
Copy link
Copy Markdown

@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 18: The README currently lists the local read-only admin commands
including peers and upstreams but the example commands section omits them;
update the examples to include usage for the peers and upstreams commands (e.g.,
show a sample invocation for peers and for upstreams including the --window-secs
flag) and/or add a short note in the capability overview explaining the purpose
of peers and upstreams so the list and examples are consistent with the CLI
implementation (referencing the peers and upstreams command names and the
--window-secs parameter).
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Repository UI (base), Organization UI (inherited)

Review profile: ASSERTIVE

Plan: Pro

Run ID: d02033bf-f06f-475e-a35f-f6cc5c8d566e

📥 Commits

Reviewing files that changed from the base of the PR and between ab0eac2 and 46a555e.

📒 Files selected for processing (15)
  • .github/workflows/release.yml
  • README.md
  • RELEASE_NOTES_v0.1.3-rc.13.md
  • docs/ARCHITECTURE_CODEBASE_MODULARIZATION_PLAN.md
  • docs/ARCHITECTURE_CODEBASE_MODULARIZATION_POLICY.md
  • docs/ARCHITECTURE_HTTP3_NGINX_ALIGNMENT_PLAN.md
  • docs/ARCHITECTURE_MODULE_LAYOUT_GUIDE.md
  • docs/ARCHITECTURE_UPSTREAM_HTTP3_PHASE0_BASELINE.md
  • docs/ARCHITECTURE_UPSTREAM_HTTP3_PRODUCTION_PLAN.md
  • docs/HTTP3_PHASE0_BASELINE.md
  • docs/HTTP3_PHASE7_RELEASE.md
  • docs/README.md
  • scripts/run-http3-gate.sh
  • scripts/run-http3-phase0.sh
  • scripts/run-http3-release-gate.sh
💤 Files with no reviewable changes (8)
  • docs/ARCHITECTURE_CODEBASE_MODULARIZATION_PLAN.md
  • RELEASE_NOTES_v0.1.3-rc.13.md
  • docs/ARCHITECTURE_UPSTREAM_HTTP3_PRODUCTION_PLAN.md
  • docs/HTTP3_PHASE0_BASELINE.md
  • scripts/run-http3-phase0.sh
  • docs/ARCHITECTURE_UPSTREAM_HTTP3_PHASE0_BASELINE.md
  • docs/ARCHITECTURE_HTTP3_NGINX_ALIGNMENT_PLAN.md
  • docs/HTTP3_PHASE7_RELEASE.md
📜 Review details
⏰ 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). (2)
  • GitHub Check: Agent
  • GitHub Check: Test Fast
🧰 Additional context used
🧠 Learnings (1)
📚 Learning: 2026-04-13T10:53:29.903Z
Learnt from: vansour
Repo: vansour/rginx PR: 43
File: crates/rginx-config/src/validate/server.rs:421-439
Timestamp: 2026-04-13T10:53:29.903Z
Learning: In `crates/rginx-config/src/validate/server.rs` (`validate_http3`), the check for `tls.session_tickets` when `http3.early_data = true` intentionally only rejects `Some(true)` and allows `None`. Requiring `Some(false)` breaks 0-RTT resumption and the `routes_http3_early_data_by_replay_safety` test and the CI `http3` gate in the current rustls/quinn integration. This is a deliberate design decision and should not be flagged as a bug until the runtime/session policy is updated to support that configuration.

Applied to files:

  • scripts/run-http3-gate.sh
🔇 Additional comments (1)
README.md (1)

78-97: 所有 README 引用的脚本均已提交仓库,无需修改。

验证结果确认:

  • scripts/uninstall.shscripts/run-fuzz-coverage.shscripts/run-modularization-gate.py 及其他脚本均已存在
  • scripts/install.sh 支持 --mode source--mode release 等所有文档列出的模式
  • scripts/run-fuzz-coverage.sh 支持 --target 参数

README 中的脚本调用示例不存在"文档承诺、脚本不存在"的问题。

Comment thread README.md
@vansour
Copy link
Copy Markdown
Owner Author

vansour commented Apr 26, 2026

Addressed the README review note in bf8b8c6 by adding sample invocations for rginx peers and rginx upstreams --window-secs 60.

@vansour vansour dismissed coderabbitai[bot]’s stale review April 26, 2026 11:23

Addressed in bf8b8c6 by documenting rginx peers and rginx upstreams --window-secs 60; the remaining CodeRabbit failure is a review rate-limit issue, not an unresolved code problem.

@vansour vansour merged commit e064ff1 into main Apr 26, 2026
6 of 7 checks passed
@vansour vansour deleted the docs/prune-stale-docs branch April 26, 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.

2 participants