docs: unify design doc path and fix broken references#169
Conversation
- Move docs/design/ files to docs/design-docs/ops/ to match ARCHITECTURE.md - Update CONTRIBUTING.md references from docs/design/ to docs/design-docs/ops/ - Remove dead link to non-existent CONTRIBUTING.zh.md in README.md Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
|
Caution Review failedThe pull request is closed. ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (4)
📝 WalkthroughWalkthroughDocumentation was updated to change the kernel design documentation path from Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related PRs
Poem
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
There was a problem hiding this comment.
Code Review
This pull request updates the directory path for kernel design documents in CONTRIBUTING.md and removes the link to the Chinese version of the contributing guide in README.md. The reviewer suggests further clarifying the path by specifying a kernel-specific subdirectory to ensure better organization of documentation.
| ## Kernel Design Requirements | ||
|
|
||
| Every new or refactored Kernel **must** have a design document in `docs/design/` covering the following: | ||
| Every new or refactored Kernel **must** have a design document in `docs/design-docs/ops/` covering the following: |
There was a problem hiding this comment.
The path docs/design-docs/ops/ is a bit ambiguous given that the MLA design document was moved to a subfolder (docs/design-docs/ops/mla/). To encourage consistent organization, it would be better to specify that design documents should be placed in a kernel-specific subdirectory.
| Every new or refactored Kernel **must** have a design document in `docs/design-docs/ops/` covering the following: | |
| Every new or refactored Kernel **must** have a design document in `docs/design-docs/ops/<kernel_name>/` covering the following: |
| ## Adding New Kernels | ||
|
|
||
| 1. Write a design document in `docs/design/` first. | ||
| 1. Write a design document in `docs/design-docs/ops/` first. |
There was a problem hiding this comment.
Summary
docs/design/files todocs/design-docs/ops/to match ARCHITECTURE.md conventiondocs/design/todocs/design-docs/ops/CONTRIBUTING.zh.mdin README.mdTest plan
docs/design/orCONTRIBUTING.zh.md🤖 Generated with Claude Code
Summary by CodeRabbit