-
Notifications
You must be signed in to change notification settings - Fork 174
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
Bring documentation back #146
Comments
If the old docs don't exist anywhere, here they are (at least some version of them) on the Wayback Machine: https://web.archive.org/web/20200224220258/http://cocoadocs.org/docsets/FeedKit/6.2.0/ |
Hi @rafaelclaycon, Do you feel the need for documentation to be separate? By the way, that documentation was generated from the code files and the README here on GitHub. You can, as an alternative, Option + Click in Xcode on any type in the project, and it will immediately display documentation for that type. The project is close to 100% documented. Cheers |
I took a look and I think your proposal works out fine. I opened a PR so that people don't miss this. |
Could also implement a DocC renderer GitHub action that publishes to GitHub pages. Would take the suggested code comments and make em full on documentation |
While literally speaking it made sense to close issue #141, this repo is still missing its documentation.
@nmdias, do you have the old files published on the now defunct CocoaDocs handy?
As a see it, there are at least two actions that need to be taken:
I'm willing to help adapting the old docs into the wiki if time is a concern.
The text was updated successfully, but these errors were encountered: