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

Integration with Dev.To #8

Open
jeanmachuca opened this issue Aug 8, 2019 · 0 comments

Comments

@jeanmachuca
Copy link
Member

commented Aug 8, 2019

There is a lot of pending documentation here to describe the wonderful features of QCObjects. So a blowing idea came to mi mind. Why not write all the related articles in a selected network like Dev.To and take these contribution articles automatically downloaded and processed to a centralised documentation website?

Dev.To has a simple and incredible REST API to do so, and using the link bellow, it is possible to get all the QCObjects related in Dev.To (just a few right now, I expect you can help me as well writing new articles :) ):

https://dev.to/api/articles?tag=qcobjects

The alternatives are:
1.- An automated side menu component injected in the main reference page.
2.- A complete other website with the automated documentation knowledge base.

Have a look at the MarkdownController in the file https://github.com/QuickCorp/QCObjects/blob/master/doc/js/cl.quickcorp.controller.js
to know how to implement an automated markdown component

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
1 participant
You can’t perform that action at this time.