Skip to content

docs: unify design doc path and fix broken references#169

Merged
0xaskr merged 1 commit intomainfrom
docs/fix-references
Apr 7, 2026
Merged

docs: unify design doc path and fix broken references#169
0xaskr merged 1 commit intomainfrom
docs/fix-references

Conversation

@0xaskr
Copy link
Copy Markdown
Collaborator

@0xaskr 0xaskr commented Apr 7, 2026

Summary

  • Move docs/design/ files to docs/design-docs/ops/ to match ARCHITECTURE.md convention
  • Update CONTRIBUTING.md references from docs/design/ to docs/design-docs/ops/
  • Remove dead link to non-existent CONTRIBUTING.zh.md in README.md

Test plan

  • Verify all internal doc links resolve correctly
  • Confirm no remaining references to docs/design/ or CONTRIBUTING.zh.md

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Updated contributing guidelines to specify new location for kernel design documentation.
    • Adjusted kernel development workflow documentation to reflect updated path requirements.
    • Removed Chinese version reference from README contributing guide links.
    • All other contribution workflow requirements remain in effect.

- 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>
@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Apr 7, 2026

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 0a5fc8d8-1907-44a8-b50e-7fb2687a672d

📥 Commits

Reviewing files that changed from the base of the PR and between b729fcd and ef85aca.

📒 Files selected for processing (4)
  • CONTRIBUTING.md
  • README.md
  • docs/design-docs/ops/mla/mla-cpu-ref.md
  • docs/design-docs/switch.md

📝 Walkthrough

Walkthrough

Documentation was updated to change the kernel design documentation path from docs/design/ to docs/design-docs/ops/ in contributing guidelines, and the link to the Chinese contributing guide was removed from the README.

Changes

Cohort / File(s) Summary
Documentation Updates
CONTRIBUTING.md
Updated design documentation path requirement from docs/design/ to docs/design-docs/ops/ for kernel design documentation.
README Maintenance
README.md
Removed reference link to the Chinese version of the Contributing Guide, keeping only the English version link.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

Poem

🐰 A rabbit hops through paths so clear,
Design docs moved—no need to fear!
From design/ to the proper way,
docs/design-docs/ops/ saves the day!
And one less tongue to cross the sea,
English guides flow wild and free! 🎉

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

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.

@0xaskr 0xaskr added this pull request to the merge queue Apr 7, 2026
Merged via the queue into main with commit a5a7d50 Apr 7, 2026
0 of 2 checks passed
@0xaskr 0xaskr deleted the docs/fix-references branch April 7, 2026 03:39
Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

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:
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

medium

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.

Suggested change
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.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

medium

Consistent with the requirement above, the instruction for adding new kernels should also point to the kernel-specific subdirectory.

Suggested change
1. Write a design document in `docs/design-docs/ops/` first.
1. Write a design document in `docs/design-docs/ops/<kernel_name>/` first.

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