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

Bring documentation back #146

Open
rafaelclaycon opened this issue Dec 8, 2022 · 4 comments
Open

Bring documentation back #146

rafaelclaycon opened this issue Dec 8, 2022 · 4 comments

Comments

@rafaelclaycon
Copy link
Contributor

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
Copy link
Contributor Author

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
Copy link
Owner

nmdias commented Dec 9, 2022

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
Copy link
Contributor Author

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

@briannadoubt
Copy link

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

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

3 participants