nmdias / FeedKit

An RSS, Atom and JSON Feed parser written in Swift
MIT License
1.19k stars 174 forks source link

Bring documentation back #146

Open rafaelclaycon opened 1 year ago

rafaelclaycon commented 1 year ago

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:

  1. Adopt GitHub Wikis: https://docs.github.com/en/communities/documenting-your-project-with-wikis/adding-or-editing-wiki-pages
  2. Remove the old docs link from the README file.

I'm willing to help adapting the old docs into the wiki if time is a concern.

rafaelclaycon commented 1 year ago

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/

nmdias commented 1 year ago

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

rafaelclaycon commented 1 year ago

I took a look and I think your proposal works out fine. I opened a PR so that people don't miss this.

briannadoubt commented 7 months ago

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