docs: add package docstring for SDK landing page (#36)#218
Open
boxcee-interview wants to merge 1 commit into
Open
docs: add package docstring for SDK landing page (#36)#218boxcee-interview wants to merge 1 commit into
boxcee-interview wants to merge 1 commit into
Conversation
Signed-off-by: Moritz Schmitz von Hülst <mschmitzvonhuelst@gmail.com>
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
1 participant
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.
Closes #36
Summary
The SDK documentation landing page was empty because the package had no init.py with a package-level docstring. pdoc generated per-module pages but no index.
This change adds a comprehensive package docstring that:
How to Test
Run the docs generation locally and verify the generated index page shows the package documentation. CI docs job runs on push to main.