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

Documentation process #5

Open
MaryBethBaker opened this issue May 25, 2017 · 2 comments
Open

Documentation process #5

MaryBethBaker opened this issue May 25, 2017 · 2 comments

Comments

@MaryBethBaker
Copy link
Member

Hi @steve-h,

Is there any part of this project where I can help document or provide context to others that might want to re-use it?

Thanks,
Mary Beth

@steve-h
Copy link
Contributor

steve-h commented May 25, 2017

I am going to do some basic high-level-view illustrations for a meeting next week and these can be added to the repo.

The code IS the document so far, and anyone reusing it now would need to have code-level understanding. It is not near turnkey deployable. As a minimum viable product, the focus was to learn about functional user experience first before deployability at scale was addressed.

I need to list the known roadmap items as well as a start to forward planning so that others know what is done and what needs work in future iterations. The dev branch is the latest and I was waiting for the first consultation to close before merging it to master.

drupalwxt uses Hugo as a documentation site base. The consultation tool would ultimately need a sophisticated approach like this. Thus a separate companion documentation repo.

Setting up such a documentation repo would be my recommendation and if you want to get an empty one going then that would be useful while waiting for content :-)

@MaryBethBaker
Copy link
Member Author

@steve-h Thanks for the suggestions. I'm excited to see the MVP and presentation next week.

@sboots Do we have experience using Hugo or does your php framework integrate with an alternative documentation repo... something like handlebar.js? Or maybe something I haven't heard of.

Thanks all!

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

2 participants