Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
0xaskr merged 1 commit into from
Apr 7, 2026
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,7 @@ Key requirements:

## 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

@gemini-code-assist gemini-code-assist bot Apr 7, 2026

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:


### 1. Algorithm and Code Logic

Expand Down Expand Up @@ -194,7 +194,7 @@ The design document must include:

## 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

@gemini-code-assist gemini-code-assist bot Apr 7, 2026

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.

2. Implement CPU reference in `tops/cpu/ops/<domain>/`.
3. Submit CPU reference for **all-core-developer review** (see [Code Review Process](#reference-implementation-changes)).
4. Implement GPU/TPU kernel in `tops/ops/<domain>/`.
Expand Down
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ from tops.modules.layernorm import RMSNorm

## Contributing

We welcome contributions! Please read our [Contributing Guide](CONTRIBUTING.md) ([中文版](CONTRIBUTING.zh.md)) to get started.
We welcome contributions! Please read our [Contributing Guide](CONTRIBUTING.md) to get started.

## License

Expand Down
0 docs/design/mla-cpu-ref.md → docs/design-docs/ops/mla/mla-cpu-ref.md
View file
Open in desktop
File renamed without changes.
0 docs/design/switch.md → docs/design-docs/switch.md
View file
Open in desktop
File renamed without changes.
Loading