Skip to content

docs: rewrite live documentation and source comments - #179

Merged
dslsdzc merged 1 commit into
developfrom
docs/engineering-docs
Oct 23, 2026
Merged

dslsdzc merged 1 commit into
developfrom
docs/engineering-docs

Conversation

@dslsdzc

@dslsdzc dslsdzc commented Oct 23, 2026

Copy link
Copy Markdown
Owner

内容

  • 重写在线文档和源码注释,删除比喻、拟人、过程历史、任务编号和旧式简写。
  • 归档 SDD 报告,删除生成的伪代码。
  • 通过共享 backend flags 模块注册后端旗标。
  • 用 ti_error() 替换负值 TI_ERROR 哨兵。
  • 删除未使用的 src/compiler/elf.cr。
  • 更新受影响的测试计数和引用。

验证

  • ./build/corec check src/compiler
  • ./build/corec selftest-types:416/416
  • ./build/corec selftest-purity:26/26
  • tests/selfhost 关键套件通过
  • 在线文档相对链接检查:0 个断链

Normalize live docs and source comments: remove metaphors, process history, task ids, dated repair notes, and obsolete shorthand. Archive SDD reports, remove generated pseudocode, and update references.

Also register backend flags through the shared backend flag module, replace the negative TI_ERROR sentinel with ti_error(), remove the unused compiler ELF writer, and update affected test counts.
@dslsdzc
dslsdzc merged commit 193fb0f into develop Oct 23, 2026
2 of 4 checks passed
@dslsdzc
dslsdzc deleted the docs/engineering-docs branch October 23, 2026 01:40
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