Yibei
05/13/2025, 11:29 PMMax
05/13/2025, 11:33 PMYibei
05/13/2025, 11:55 PMNikhil Gupta
05/21/2025, 7:35 PMMax
05/23/2025, 2:12 AM<http://docs.nixtla.io|docs.nixtla.io>
. This was suboptimal:
• Fragmented web presence (3 domains with 3 different platforms: <http://nixtla.io|nixtla.io>
, <http://docs.nixtla.io|docs.nixtla.io>
, <http://nixtlaverse.nixtla.io|nixtlaverse.nixtla.io>
)
• Manual work for every update
• Poor design
• No custom JS unless we paid $3K/month (needed for analytics, tracking, Intercom)
What changed:
With the new website, we dropped readme.com and now use Mintlify at <http://nixtla.io/docs|nixtla.io/docs>
. Docs are rendered from simple MDX files.
Pros:
• Simpler
• Looks better
• Fully owned and customizable
• Full MDX-based, no nbdev dependency. (CMS: Supports visual editing from the mintlify website)
Cons:
• Not nbdev-based (I see this as a pro)
• API section removed
• Content was revised for clarity, grammar, and style
Why I removed the API reference (arguments):
• Product: Our SLG strategy targets enterprise users who should use SDKs or integrations (e.g. Snowflake), not raw API calls. SDKs are more stable and feature-rich.
• Docs: The old API docs were confusing — multiple versions, beta labels, unclear structure.
• Commercial: Only one paying user ($100/month) still calls the API directly. They use Python and should be using the SDK.
Can we include the API reference in the new docs?
• Yes — Mintlify supports it. We have OpenAPI specs.
Should we?
• IMO: No — not for now. I aligned with @Nikhil Gupta and @Cristian Challu: we think its not worth the effort at this stage.
How can I contribute to the docs?
• Code Editing: Currently the docs of timegpt are in the docs folder of our website repo . Follow the instructions in the readme and contact @Edu if you have any troubles.
• Visual editing: access https://dashboard.mintlify.com/ and use the CMS tool.
cc: @Han Wang, @Cristian Challu, @Olivier Sprangers, @Marco.Nikhil Gupta
05/23/2025, 6:09 PM