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

[Doc] User suggestions on documentations #517

Open
8 tasks
Yibei990826 opened this issue Nov 1, 2024 · 1 comment
Open
8 tasks

[Doc] User suggestions on documentations #517

Yibei990826 opened this issue Nov 1, 2024 · 1 comment

Comments

@Yibei990826
Copy link
Contributor

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
Copy link
Member

ngupta23 commented Nov 4, 2024

  • 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

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

2 participants