Skip to content

Commit 7c5cdf9

Browse files
committed
docs: simplify homepage
1 parent 03bc363 commit 7c5cdf9

3 files changed

Lines changed: 4 additions & 116 deletions

File tree

docs/README.md

Lines changed: 4 additions & 75 deletions
Original file line numberDiff line numberDiff line change
@@ -1,76 +1,5 @@
1-
# PTO Docs
1+
# Docs
22

3-
<div class="home-hero" markdown>
4-
5-
PTO intrinsic / IR 笔记与设计文档集合,侧重可落地的语义解释与边界约束。
6-
7-
[从 VecTile 开始](vectile-design.md){ .md-button .md-button--primary }
8-
[vbrcb 指令指南](vbrcb-instruction-guide.md){ .md-button }
9-
[PTO IR Manual](pto-ir-manual.md){ .md-button }
10-
11-
</div>
12-
13-
## 核心入口
14-
15-
<div class="grid cards" markdown>
16-
17-
- ### VecTile 设计
18-
19-
A2/A3 后端的 tiling 抽象:调度与指令映射解耦、Lowering 规则、repeat/stride 边界。
20-
21-
**适合**:想快速建立 PTO-ISA “在做什么 / 为什么这样做” 的整体直觉
22-
**关键词**`VecTile` / `VecIssue` / `RowRepeat`
23-
24-
[打开文档](vectile-design.md){ .md-button .md-button--primary }
25-
26-
- ### vbrcb 指令指南
27-
28-
`vbrcb` 的参数语义、布局转换、典型广播场景,以及 repeat 上限时的拆分策略。
29-
30-
**适合**:需要写/看 UB 侧广播预处理代码
31-
**关键词**`repeat` / `dst_rep_stride` / `pipe_barrier`
32-
33-
[打开文档](vbrcb-instruction-guide.md){ .md-button }
34-
35-
- ### PTO IR Manual
36-
37-
PTO IR 的字段语义、约束与约定用法,作为实现和调试时的快速查表。
38-
39-
**适合**:做 IR 相关开发、review、排查问题
40-
**关键词**:IR 结构 / memory / event
41-
42-
[打开手册](pto-ir-manual.md){ .md-button }
43-
44-
</div>
45-
46-
## 推荐阅读顺序
47-
48-
!!! tip "建议从上到下读一遍"
49-
1. `VecTile`:先建立整体抽象和 lowering 的直觉
50-
2. `vbrcb`:再看具体指令在 UB 上怎么落地
51-
3. `PTO IR Manual`:最后用手册补齐细节和约束
52-
53-
## 本地预览
54-
55-
```bash
56-
cd /data/sunwenbo/pto/tech-lab-notes
57-
python3 -m venv .venv
58-
source .venv/bin/activate
59-
pip install -r requirements.txt
60-
mkdocs serve
61-
```
62-
63-
```text
64-
http://127.0.0.1:8000
65-
```
66-
67-
## 线上地址
68-
69-
```text
70-
https://wenbocodes.github.io/tech-lab-notes/
71-
```
72-
73-
## 约定
74-
75-
- 新增页面:放在 `docs/`,文件名用 kebab-case,并同步更新 `mkdocs.yml``nav`
76-
- 合并前自检:`mkdocs build --strict`
3+
- [A2/A3 VecTile 设计文档](vectile-design.md)
4+
- [vbrcb 指令详细使用指南](vbrcb-instruction-guide.md)
5+
- [PTO IR Reference](pto-ir-manual.md)

docs/stylesheets/extra.css

Lines changed: 0 additions & 33 deletions
This file was deleted.

mkdocs.yml

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,6 @@ repo_name: WenboCodes/tech-lab-notes
55
docs_dir: docs
66
theme:
77
name: material
8-
markdown_extensions:
9-
- attr_list
10-
- md_in_html
11-
- admonition
12-
- pymdownx.details
13-
- pymdownx.superfences
14-
extra_css:
15-
- stylesheets/extra.css
168
nav:
179
- 首页: README.md
1810
- VecTile 设计: vectile-design.md

0 commit comments

Comments
 (0)