Repository navigation
[docs] Overhaul documentation for #589 - #594
Merged
Merged
Conversation
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
Breakthrough
force-pushed
the
issue-589-improved-docs
branch
from
November 2, 2026 01:35
de0ad97 to
b83c17d
Compare
Breakthrough
force-pushed
the
issue-589-improved-docs
branch
from
November 2, 2026 03:02
b83c17d to
9ee0d73
Compare
MuhammadBilalKhan267
approved these changes
Nov 6, 2026
MuhammadBilalKhan267
left a comment
MuhammadBilalKhan267
left a comment
Collaborator
There was a problem hiding this comment.
LGTM! Left two minor non-blocking comments.
Breakthrough
force-pushed
the
issue-589-improved-docs
branch
from
November 7, 2026 23:50
9ee0d73 to
ae621fb
Compare
The documentation was in dire need of some improvements as the volume of features PySceneDetect supports has grown. This splits out the CLI and API docs as separate entities, while making it easier to switch between the two. It also improves the ability to find config file docs and sections.
Breakthrough
force-pushed
the
issue-589-improved-docs
branch
from
November 8, 2026 00:05
ae621fb to
1449197
Compare
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
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.
The documentation was in dire need of some improvements as the volume of features PySceneDetect supports has grown. This splits out the CLI and API docs as separate entities, while making it easier to switch between the two. It also improves the ability to find config file docs and sections.
The docs generator now supports relations between similar items across each surface (API, CLI, and config file).