Add MkDocs documentation with multi-language API reference - #33
Conversation
Co-authored-by: hzhangxyz <11623447+hzhangxyz@users.noreply.github.com>
Co-authored-by: hzhangxyz <11623447+hzhangxyz@users.noreply.github.com>
hzhangxyz
left a comment
There was a problem hiding this comment.
- 请使用mkdocstrings来做c++和typescript的reference, c++的docstring是中文, 请无视,后面我会在另一个issue/pr处理这个, 你直接使用docstring做reference
- 开头的架构的格式有点问题, 你的制表符错位了几个, 你可以抄下面这个
┌────────────────────────────────────────────────────────────┐
│ Application Layer │
├────────────────────┬────────────────────┬──────────────────┤
│ TypeScript (atsds) │ Python (apyds) │ C++ Direct │
│ via WebAssembly │ via pybind11 │ │
├────────────────────┴────────────────────┴──────────────────┤
│ C++ Core Library │
│ (include/ds/, src/) │
└────────────────────────────────────────────────────────────┘
- getting-started/installation 中, 顺序按照typescript, python, c++的来
- typescript/javascript的node版本依赖是20+, 而不是现在说的16+, 我只测试了20+的
- C++20 compatible compiler 这个不要举例子说" (GCC 10+, Clang 10+, MSVC 2019+)", 少说少错
- typescript的例子中, 少用 "?.toString" 或者其他 "?." 不然在python这边不一致
- core concept中的Logical Systems和Custom Domains删掉, 这个是search engine那边的东西
…js version, remove ?. usage Co-authored-by: hzhangxyz <11623447+hzhangxyz@users.noreply.github.com>
Addressed all feedback in commit da6b2ce:
|
hzhangxyz
left a comment
There was a problem hiding this comment.
既然不方便就为了维持一致性,python的api reference也你来手动写吧
请注意一下:三个语言的reference的风格一致性,以及core concept中,term和rule的一致性,比如他们的grounding现在并不是同一个层级的。
…tructure consistency Co-authored-by: hzhangxyz <11623447+hzhangxyz@users.noreply.github.com>
Addressed in commit fe95ba0:
|
hzhangxyz
left a comment
There was a problem hiding this comment.
cxx的Utility Functions写错了,我只实现了term和rule到text的反过来的函数
另外,安装那个页面,Requirements of python的格式字体似乎和其他两个语言不一样
Co-authored-by: hzhangxyz <11623447+hzhangxyz@users.noreply.github.com>
Fixed in commit cc9588b:
|
?.toString()usage in TypeScript examplesOriginal prompt
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.