[Doc] User suggestions on documentations

Nixtla / nixtla

TimeGPT-1: production ready pre-trained Time Series Foundation Model for forecasting and anomaly detection. Generative pretrained transformer for time series trained on over 100B data points. It's capable of accurately predicting various domains such as retail, electricity, finance, and IoT with just a few lines of code 🚀.

https://docs.nixtla.io

Other

2.31k stars 187 forks source link

[Doc] User suggestions on documentations #517

Open Yibei990826 opened 2 weeks ago

Yibei990826 commented 2 weeks ago

Description

These are suggestions for ducumentation from our users, with the numbers indicating how many times each they was mentioned:

Documentation

[ ] Improved organization for better navigation.(2)
[ ] A basicoverview of how TimeGPT works (2).
[ ] Information on data security practices. (2)
[ ] Detailed guidance on num_partitions usage.(1)
[ ] Details on API usage calculation.(1)
[ ] Clear version control instructions.(1)
[ ] Explanation of add_history functionality.(1)
[ ] Inclusion of an anomaly detection guide.(1)

Link

No response

ngupta23 commented 1 week ago

Improved organization for better navigation.(2)

As a relatively new user, I would agree with this. For example, there seem to be two notebooks for each capability (one short and one more detailed). At the very least, there should be a banner on the top of the short notebook that also points the user to the more detailed version of the notebook as the "read next" action.

e.g.

Basic Notebook for handling categorical variables Detailed Notebook for handling categorical variables