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.

Sign up for GitHub

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

Jump to bottom

Improve the docs and move to a separate place (not the README) #146

Closed
hairyhenderson opened this issue May 24, 2017 · 1 comment
Closed

Improve the docs and move to a separate place (not the README) #146

hairyhenderson opened this issue May 24, 2017 · 1 comment
Assignees
@hairyhenderson
Labels
documentation

Comments

@hairyhenderson
Copy link
Owner

The README's already ridiculously long (~900 lines), and I'm not happy with the level of detail in the built-in function docs (for example, it doesn't list function parameters in any sort of consistent way).

I think at least splitting the docs out of the README is a prerequisite to being able to start adding large numbers of functions (such as is being discussed in #145). Probably for now, a simple static site would be the best option. Just moving the relevant Markdown from the README would be a good first step.
@hairyhenderson hairyhenderson self-assigned this May 24, 2017
@hairyhenderson hairyhenderson mentioned this issue May 24, 2017
Closed
@hairyhenderson
Copy link
Owner Author

I suppose this has been fixed by #149... ¯\_(ツ)_/¯ See https://gomplate.hairyhenderson.ca

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@hairyhenderson hairyhenderson

Labels
documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@hairyhenderson