-
Notifications
You must be signed in to change notification settings - Fork 158
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Readme Access #428
Comments
This sounds pretty good, but I think instead of the readme, it should be possible to have multiple pages, and have translation support built in. My current idea is: Each plugin can have a docs folder that contains several folders, each representing a page. Each folder then contains one or more markdown pages, with each one being a different language. The pages are displayed with a The displayed page name has to go into the markdown file so it can be translated. Maybe first line is the title? If multiple pages is unreasonable then they can just put the markdown files directly into the docs folder. If there isn't a docs folder then it can just fall back onto the readme.md.
The multiple pages thing isn't particularly needed, but I'd quite like to include translation support in this. When I have some free time I'll do some tinkering with getting this working, because I'd really like this (no promises though!). |
~/homebrew/docs/{plugin}/{language code}/{page}.md |
Or maybe |
It'd be this yeah, and if /docs doesn't exist it would instead use /readme.md (case independent of course), or so I gather from PartyWumpus! |
I think this one is best, as the data is only ever going to change when the plugin updates and it reduces the extra file management stuff required from decky |
Decky could add a parameterized route at /docs/:plugin and it would be a sidebar navigation with each page as a tab. Obviously localized and the default locale would be English when there isn't a translation for a page because internet |
Devs could set up crowdin for their repos so that people can translate the docs |
We could also perhaps offer plugin developers space on our Weblate instance. |
Does weblate support markdown? |
Weblate does not appear to support markdown Also, my work in progress version is now up (#432), although it will not work for now unless you manually modify it to remove the i18next depedency. |
Technically no, but it does support text files |
In all likelyhood, it would be best to just have plugins explain their functionality inside of their UI and link to webpages if absolutely necessary. |
Please confirm
Feature Request Description
If a plugin has a readme, it can be viewed without needing to go through with a file manager.
Further Description
When a plugin has been opened from the list, an ℹ️ button is next to the plugin name up top. When pressed, it shows the text within the readme file, URLs are hyperlinked.
The text was updated successfully, but these errors were encountered: