Add Sphinx documentation and GitHub Pages workflow #2
+446
−0
Conversation
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
Introduces Sphinx-based documentation for the project, including configuration, requirements, and initial content for adapter and protocol documentation. Adds a GitHub Actions workflow to build and publish the documentation to GitHub Pages on release or manual trigger. Also includes .gitignore updates to exclude build artifacts and IDE files.
|
rafa-be
approved these changes
Aug 26, 2025
| 401: | ||
| description: Unauthorized, e.g., invalid or missing auth_token | ||
| schema: | ||
| $ref: '#/definitions/Error' |
There was a problem hiding this comment.
We probably need a 404 error for unknown worker_ids.
sharpener6
reviewed
Aug 26, 2025
docs/source/adapter/scaling.rst
Outdated
| from scaler.utility.mixins import Reporter | ||
|
|
||
| class ScalingController(Reporter, abc.ABC): | ||
| async def on_state_client(self, state_client: StateClient): |
There was a problem hiding this comment.
should be decorated by @abc.abstractmethod
sharpener6
reviewed
Aug 26, 2025
docs/source/adapter/webhook.rst
Outdated
| │ └────────┘ | ||
| │ | ||
| ┌───────────┐ Webhook Requests ┌───────┴─┐ Start ┌────────┐ | ||
| │ Scaling ├───────────────────► Adapter ├────────► Worker │ |
There was a problem hiding this comment.
let's change the wording adapater to WorkerManagerAdapter
There was a problem hiding this comment.
also this chart might be better went to the summary page
- summary:
- user need implement allocate policy or using existing ones
- user need implement worker manager adapters or using existing ones
- then chart
- briefly explain the roles of above
Then you have 2 separate pages talks about
- how allocate policy is implemented in detail
- how worker manager adapter is implemented, also include detail about json formatting etc.
There was a problem hiding this comment.
in the summary you can also draw graph about how client, scheduler, worker, worker manager adapters, allocate policy works, give them an overview.
Always better give them overview, and define the terminologies, then break down each name and for the detail
Replaces references to individual workers with worker groups in schema.yaml and documentation. Updates webhook request and response examples, handler method names, and scaling controller implementation notes to reflect the new worker group model.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 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.
Introduces Sphinx-based documentation for the project, including configuration, requirements, and initial content for adapter and protocol documentation. Adds a GitHub Actions workflow to build and publish the documentation to GitHub Pages on release or manual trigger. Also includes .gitignore updates to exclude build artifacts and IDE files.