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

Generate reference pages #114

Closed
pepicrft opened this issue Aug 30, 2018 · 3 comments
Closed

Generate reference pages #114

pepicrft opened this issue Aug 30, 2018 · 3 comments
Labels
good first issue Good for newcomers type:enhancement New feature or request

Comments

@pepicrft
Copy link
Contributor

What 🕵️‍♀️

Like CocoaPods does to document the syntax of the Podfile and the .podspec files, we should have a reference on the website as well. The reference is useful for developers to know which attributes are available in the API and their keys when defining the manifests as a yaml or json.

@santos88
Copy link
Contributor

santos88 commented Oct 5, 2018

@pepibumur is this issue regarding to upload the current /doc files into a public server? or to choose an alternative to the current Jazzy auto generated documentation?

@pepicrft
Copy link
Contributor Author

pepicrft commented Oct 5, 2018

The goal of the task is:

  • Add the .jazzy.yaml file in those Swift projects that don't have it.
  • Update the RELEASE.md and include a step to generate the documentation by running this script
  • Enable GitHub pages for those repositories (from the /docs directory)

I'll update the website and add a new section where we list all the organization projects.

@pepicrft
Copy link
Contributor Author

This is already done :). All projects are now listed here and include a link to their references.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers type:enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants