Skip to content
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

Online/Offline docs for popular programmatic langs in feed[latest] missing #4912

Open
hifron opened this issue Apr 11, 2024 · 2 comments
Open

Comments

@hifron
Copy link

hifron commented Apr 11, 2024

If there is some small(but important) change like on Stripe docs, you have to download such html docs(in some supported format), make some import files and make some feed xml and make pull request and make it official altough Stripe is official :) and when all these settles you have your online docs in your app. For some time like 5 seconds. Currently there are fast network connections and built in features could incorporate such quality assured Stripe online docs and cache is for that and official docs are already in some formats :), but some neat application is needed and not only on MacOsX and for me seems weird these problems but some app needed.

There are official docs like successor of OpenGL named Vulkan missing or even Microsoft MSDN or Mozilla MDN and that is their property(like for Khronos) with maybe ads or additional stuff including licensing for industrial usage and patents coverage. And think even Google ever changing API for their Products or even some usages for langs but may vary for countries or company Coursera or University needs.

Your current offerings in feed is also from programmatic way too limited, but adding ever changing docs is too time consuming and could be automated, but also there is another Way of Think when additional internal corporate needs occur.

Think about assurance that your offering of docset need some practical certification when you have no time to update or search and when is need also outside Mac like on Windows or Linux and some practical app is needed maybe even on Phone or corporate network and Zeal is candidate for corporate needs but your offering is not yet enabled for such usage.

@hifron
Copy link
Author

hifron commented Jun 19, 2024

Seems like authors like this https://devhints.io/ who made some issue on Dash cheatsheets have similar problem with outdated informations.

I think that in todays world having regular contributors(with some automation or Github bots) who could do a much more than such devhints could make a more choices for this project or its orientations and if Linux/Windows apps are included in repositories or some online portal(or its apps) available according user needs(and PWA apps waiting including Android...) so contributors or freelancers waiting to make it more uptodate or according this project issues...

@hifron
Copy link
Author

hifron commented Nov 28, 2024

A lot of docsets in docset dir is outdated, maybe there should be option for authors of such packages to make proposal to make their documentation available to docset dir and maybe make some bot, but also maybe purge old docs which is not relevant anymore or even may contain harmful information... so purge such docs and make new proposal or offering is better... and authors of popular framework like wordpress could make their choices even when in vscode is zeal plugin...

alternative is use standard libs folders like in unix where programs like DevHelp from GNOME has support for not only GNOME development configurations in standard format but dealings with official documentation and data packages and bundles could make it better development world...

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

No branches or pull requests

1 participant