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

Missing guidelines for publishing and broken documentation #13

Open
gandhiano opened this issue Jan 15, 2016 · 3 comments
Open

Missing guidelines for publishing and broken documentation #13

gandhiano opened this issue Jan 15, 2016 · 3 comments

Comments

@gandhiano
Copy link
Member

README.md is still pointing to the original @keikreutler repository and the instructions seem to be incomplete. They are at least unclear to me and despite my merge into source (is it the repo where one should merge?), there is nothing changing on the main page.

@almereyda
Copy link
Member

This is related to keikreutler#1

@almereyda
Copy link
Member

The hanging issue at the source repository of this just links to an examplatory README template. We could use it to refine the current one, also in conformance with the structure from the api README.

@almereyda almereyda changed the title Update README.md to provide proper guidelines for publishing Missing guidelines for publishing and broken documentation Mar 11, 2016
@almereyda
Copy link
Member

The publishing workflow circulates around the combination of GitHub pages in combination with DocPad. Both compartiments may want to be described in the documentation, too.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants