[DOC] add FAQ section for v2 API (#2305) - #2337
Open
kayne-lee wants to merge 2 commits into
Open
Conversation
Adds docs/source/faq_v2.rst covering architecture, data handling, training/prediction, and contributing questions for the v2 API, and links it from the api_v2 toctree. Follows the style of the v1 faq.rst and the existing v2 doc pages (same beta warning banner, same Q&A format).
kayne-lee
requested review from
benHeid,
fkiraly,
jdb78 and
phoeenniixx
as code owners
July 9, 2026 02:27
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #2337 +/- ##
=======================================
Coverage ? 87.46%
=======================================
Files ? 175
Lines ? 10165
Branches ? 0
=======================================
Hits ? 8891
Misses ? 1274
Partials ? 0
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
phoeenniixx
added
documentation
phoeenniixx
requested changes
Aug 4, 2026
phoeenniixx
left a comment
phoeenniixx
left a comment
Member
There was a problem hiding this comment.
Thanks!
I think we should also add a link of this faq to v1 faq (inside the info box - Try the API v2 pre-release!) like there is links to v2 API in v1 API docs
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #2305
Adds an FAQ page for the v2 API (
docs/source/faq_v2.rst) and links it from theapi_v2toctree.Notes
faq.rstand the v2 doc pages (same beta warning banner, same Q&A format).api_v2.rst,data_v2.rst,models_v2.rst,pkg_v2.rst,m_layer_v2.rst, theTimeSeriesandEncoderDecoderTimeSeriesDataModuledocstrings, andextension_templates/v2).make htmlbuild: build succeeds and no Sphinx warnings mentionfaq_v2.