Conversation
There was a problem hiding this comment.
Pull request overview
This PR adds comprehensive plugin reference documentation for the Heimdall scheduling system. The documentation covers profile handlers, filters, scorers, pickers, and response plugins used in Heimdall's configuration. The PR also updates the AGENTS.md file to formalize the sidebar_position frontmatter requirement and adds helpful Docusaurus reference links.
Changes:
- Added new plugin reference documentation (plugin.mdx) with detailed parameter tables for all Heimdall plugin types
- Updated api-reference.mdx to include sidebar_position field in frontmatter
- Enhanced AGENTS.md with sidebar_position requirement and Docusaurus documentation links
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| website/docs/reference/heimdall/plugin.mdx | New comprehensive reference documentation for Heimdall plugins including profile handlers, filters, scorers, pickers, and response plugins |
| website/docs/reference/heimdall/api-reference.mdx | Added sidebar_position field to frontmatter for proper sidebar ordering |
| website/AGENTS.md | Updated documentation guidelines to include sidebar_position in frontmatter template and added Docusaurus reference links |
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
| --- | ||
| title: Heimdall Plugin | ||
| sidebar_label: Plugin | ||
| sidebar_position: 2 | ||
| --- |
There was a problem hiding this comment.
The frontmatter doesn’t follow the contributor guidance in website/AGENTS.md that says to wrap title in single quotes. Either update this page’s frontmatter to match the rule or adjust the rule to reflect the actual convention used across the docs.
|
|
||
| ### `active-request-scorer` | ||
|
|
||
| Scores pods based on the number of active requests being served. Scores are normalized from 0 to 1. |
There was a problem hiding this comment.
Grammar: “Scored normalized from 0 to 1.” is ungrammatical and reads like a typo. Consider rephrasing to something like “Scores are normalized from 0 to 1.”
| Scores pods based on the number of active requests being served. Scores are normalized from 0 to 1. | |
| Scores pods based on the number of active requests being served. The scores are normalized to the range [0, 1]. |
| | Parameter | Type | Default | Description | | ||
| | :------------- | :---- | :------ | :------------------------------------- | | ||
| | `size` | `int` | `1e8` | Maximum number of keys in the index. | | ||
| | `podCacheSize` | `int` | `10` | Maximum number of pod entries per key. | |
There was a problem hiding this comment.
inMemoryConfig.size is documented as an int but the default is written as 1e8. Many configuration formats treat scientific notation as a float (or reject it for integers), so this default may be confusing/misleading. Prefer spelling this out as an integer literal (e.g., 100000000) if that’s the intended value.
| | Parameter | Type | Default | Description | | |
| | :------------- | :---- | :------ | :------------------------------------- | | |
| | `size` | `int` | `1e8` | Maximum number of keys in the index. | | |
| | `podCacheSize` | `int` | `10` | Maximum number of pod entries per key. | | |
| | Parameter | Type | Default | Description | | |
| | :------------- | :---- | :--------- | :------------------------------------- | | |
| | `size` | `int` | `100000000`| Maximum number of keys in the index. | | |
| | `podCacheSize` | `int` | `10` | Maximum number of pod entries per key. | |
| --- | ||
| title: Heimdall API Reference | ||
| sidebar_label: API Reference | ||
| sidebar_position: 1 | ||
| --- |
There was a problem hiding this comment.
The frontmatter doesn’t follow the contributor guidance in website/AGENTS.md that says to wrap title in single quotes. Either update this page’s frontmatter to match the rule or adjust the rule to reflect the actual convention used across the docs.
| - **Frontmatter**: All `.mdx` files must start with the following (wrap titles in single quotes): | ||
| ```mdx | ||
| --- | ||
| title: <title> | ||
| sidebar_label: <label> | ||
| sidebar_position: <position> | ||
| --- | ||
| ``` |
There was a problem hiding this comment.
This section says “wrap titles in single quotes”, but the example frontmatter block doesn’t show quotes around title, and the new sidebar_position requirement isn’t reflected elsewhere in the docs (e.g., existing pages omit it). Please make the written rule and the example consistent, and clarify whether sidebar_position is mandatory or only recommended for ordering.
No description provided.