Back

Docs section structure

Hi

Please add an option to view the reference docs as one continous page. The search function is not very useful making it hard to locate relevant sections across the reference and other documents.

Thanks!

Update Backtest








yep !! 99% on JM side

and morning star is missing

 

https://zapier.com/engineering/great-documentation-examples/http://blog.screensteps.com/10-examples-of-great-end-user-documentation

 

https://www.atlassian.com/blog/add-ons/5-real-life-examples-beautiful-technical-documentation

:)

0

i was waiting till someone says something :)

it should be open so everyone can scroll to the end and search text like morning star :) :) :) :) :) :) :) :) :) :) :) :)

with the browser build in text search.

0

Thanks for the feedback. Unfortunately there's no answer which will make everyone happy, but we changed the documentation from long form to short form after 5 years experience with long form and much deliberation and design. We mirrored popular API companies like Stripe when we made this change. We've found short form encourages reading the section where long form mostly results in people skipping everything as its too long to read.

We will consider making it viewable in both modes. It shouldn't be too tricky. 

0

The material on this website is provided for informational purposes only and does not constitute an offer to sell, a solicitation to buy, or a recommendation or endorsement for any security or strategy, nor does it constitute an offer to provide investment advisory services by QuantConnect. In addition, the material offers no opinion with respect to the suitability of any security or specific investment. QuantConnect makes no guarantees as to the accuracy or completeness of the views expressed in the website. The views are subject to change, and may have become unreliable for various reasons, including changes in market conditions or economic circumstances. All investments involve risk, including loss of principal. You should consult with an investment professional before making any investment decisions.


Jared Broad 

maybe something like this would help out:

https://github.com/xriley/PrettyDocs-Themehttps://themes.3rdwavemedia.com/website-templates/prettydocs-free-bootstrap-theme-developers-and-startups/
0

Update Backtest





0

The material on this website is provided for informational purposes only and does not constitute an offer to sell, a solicitation to buy, or a recommendation or endorsement for any security or strategy, nor does it constitute an offer to provide investment advisory services by QuantConnect. In addition, the material offers no opinion with respect to the suitability of any security or specific investment. QuantConnect makes no guarantees as to the accuracy or completeness of the views expressed in the website. The views are subject to change, and may have become unreliable for various reasons, including changes in market conditions or economic circumstances. All investments involve risk, including loss of principal. You should consult with an investment professional before making any investment decisions.


Loading...

This discussion is closed