search

yazi-rs / yazi-rs.github.io

Documentation site for Yazi.
https://yazi-rs.github.io
MIT License
22 stars 78 forks source link

Api type annotation #35

Closed PaysanCorrezien closed 7 months ago

PaysanCorrezien commented 8 months ago

Hi, First, thanks i'm realy hyped by the plugins system 🔥 . I have lot of fun idea of thing we can build with it . I tried to look at the plugins docs a bit and i have the same issue with yazi than i have with wezterm. It's the fact that we need to spend more time on the web docs than in the editor because we dont have types infos builtin. For wezterm i found this Github user config . It is made manually and probably not up to date, but it already helps. I think providing something similar for yazi would be nice. I searched for a way to automatically generate documentation but only found Tealr. It might work for markdown documents, but it doesn't seem to provide the LuaLs types. I can maybe do it manually for now, but I think there might be a better solution for doing that automatically. Do you have any thoughts on this? Thanks, Dylan

sxyazi commented 8 months ago

The current documentation is maintained manually, and I think it might be challenging to automate it because the internal code structure of Yazi is different from what is eventually presented to plugin developers. Perhaps we can just enhance the existing plugin documentation?

github-actions[bot] commented 7 months ago

This issue has been automatically closed because there has been no response to our request for more information from the original author. With only the information that is currently in the issue, we don't have enough information to take action. Please reach out if you have or find the answers we need so that we can investigate further.

github-actions[bot] commented 6 months ago

I'm going to lock this issue because it has been closed for 30 days. ⏳ This helps our maintainers find and focus on the active issues. If you have found a problem that seems similar to this, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.