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

Improve documentation #86

Open
timiwahalahti opened this issue Jan 12, 2018 · 3 comments
Open

Improve documentation #86

timiwahalahti opened this issue Jan 12, 2018 · 3 comments

Comments

@timiwahalahti
Copy link
Member

We need to improve inline documentation and also open a GitHub wiki that documents every hook properly.

@anttiviljami
Copy link
Collaborator

I'm against using Github wiki for documentation. Add API.md or something instead so we can keep docs in source control.

@k1sul1
Copy link
Member

k1sul1 commented Jan 12, 2018

Just add docblocks and autogenerate the docs, publish on ghpages.

One addition to composer.json:

"phpdoc": "phpdoc -n -t docs -d modules --template=\"responsive-twig\"; git add docs; git commit -m \"Update documentation\""

@timiwahalahti
Copy link
Member Author

At the same time, let's introduce better changelog as keepachangelog.com that contains also Unreleased section.

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