smartxworks / cloudtower-api-doc-tauri

tauri app

how to update web

url: https://cloudtower-api-preview.vercel.app/

every push commit will trigget vercel develop a new url env; every pr will trigger vercel develop a new dev url env;

how to update app

when add a new tag v* will trigger github action to release new assets, includes source code and desktop app

for developer

how to setup repo

run yarn install --pure-lockfile && yarn start

how to update api swagger

1. add new version in versions.json
2. run yarn api:sync

how to quick create new api docs

run yarn api:new

how to check document missing locales

run yarn api:scan

how to add new documents / markdown file

please see: https://docs.google.com/document/d/1h9Wjd2yPfoAyZ-1dCa8IH5ltDK6kYglEzW-w4hu72pA/edit

cloudtower-api-doc-tauri's Issues

support global search

need to add english doc for golang markdown

set up i18n server

set up better i18n server for add locales

补充 unique_size 的版本说明

需要说明一下新旧版本的不同

http://gitlab.smartx.com/frontend/tower/-/merge_requests/9615#note_315420

update i18n locales in swagger component

修改 size 字段解释

Add SDK Example Page

like this: https://developer.qiniu.com/

need add tag for api to present relationship between api endpoint and sdk api instance

上架在线下载 doc 文档的功能

提高搜索效率

可以看下集成 pagefind 的效果

https://pagefind.app/docs/running-pagefind/

https://github.com/a11ywatch/auto-pagefind/blob/main/react/lib/pagefind.tsx

切换 Request samples 语言会导致其他 ap i的 Request samples 也切换语言

不同语言的 request samples 长度不同，切换后会导致页面的scroll无法对其现有的 api 示例

对于嵌套的where条件，我们应该列出该项和类型而非隐藏

目前where条件内嵌套的where条件，因为展开时的性能问题，都被隐藏了。
我们应当阻止他的展开，而非直接将该项隐藏，导致参数的结构和文档的不相符。

文档更新

• 更新 create-snapshot-plan 的字段说明
• 日期类字符串需要提供有意义的变量
• 更新 metric 字段说明， 例如： host_hp_memory_usage_percent

add script to handle new version docs workflow

a typical scenario of adding new version docs like this: 80043c6

need to optimize workflow

同步 terraform 文档

try it 面板增强交互

• 增加多一个 server 需要输入回车找个交互需要说明/或者改成按键式
• 提示需要从 http -> https

title 根据当前浏览的api变更名称

当前处于某个 api 下的时候， title 不会变化

如果可以显示对应的 api，分享链接时会更加直接

optimize swagger parser

optimize app and scripts swagger parser.

增加单独的 schema 列

curl 脚本优化

UI improvement

1. 更新通用指南，说明通用参数
   
2. 这里对于参数可以使用一个表格来描述
   
3. 这种标题和内容隔得有些远
   
4. 夜间模式这里还留有空白
   
5. 这部分内容排版可以更紧凑些
   

需要区分不同版本下的示例展示

以 delete-vm 为例，3.4 和 2.6 的示例应该是不同的，目前展示的都是最新的 schema 示例。但是实际上存在部分字段 2.6 是没有的。

部分api名称没有i18n化

Optimize Search

Optmize Search for tag search / api name search / api description search

api:new 脚本的 enum 检查错误

新增 enum 不能被及时更新，需要检查一下相关脚本