fix: resolve #8628 — Documentation: Document API for programmatic use by tang-vu · Pull Request #13483 · serverless/serverless

tang-vu · 2026-04-04T19:02:41Z

Summary

fix: resolve #8628 — Documentation: Document API for programmatic use

Problem

Severity: Medium | File: docs/sf/menu.json

Update the documentation menu to include the newly created Programmatic API guide under the "Guides" section.

Solution

Add an entry for "Programmatic API" in the menu.json file, likely under the "Guides" or "Plugins" category depending on the existing structure.

Changes

docs/sf/menu.json (modified)
docs/sf/guides/plugins/creating-plugins.md (modified)

Testing

Existing tests pass
Manual review completed
No new warnings/errors introduced

Generated by ContribAI v5.7.1

Summary by CodeRabbit

Documentation
- Added a reference to Programmatic API documentation in the serverless instance section.
- Updated navigation menu to include Programmatic API as a top-level entry for easier access to reference materials.

…mmatic use Fixes serverless#8628 Signed-off-by: Tang Vu <145498528+tang-vu@users.noreply.github.com>

Mmarzex · 2026-04-04T19:02:54Z

✅ Snyk checks have passed. No issues have been found so far.

Status	Scan Engine	Critical	High	Medium	Low	Total (0)
✅	Open Source Security	0	0	0	0	0 issues
✅	Licenses	0	0	0	0	0 issues
✅	Code Security	0	0	0	0	0 issues

💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse.

coderabbitai · 2026-04-04T19:02:55Z

📝 Walkthrough

Walkthrough

Documentation infrastructure is established for a Programmatic API guide by adding a new navigation menu entry and inserting a reference note within the plugin creation guide, directing users to the new documentation resource.

Changes

Cohort / File(s)	Summary
Documentation Navigation `docs/sf/menu.json`	Added "Programmatic API" entry under the Usage section with path reference to `guides/programmatic-api`.
Plugin Guide References `docs/sf/guides/plugins/creating-plugins.md`	Inserted a documentation note in the "Serverless instance" section linking to Programmatic API docs for extended guidance.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Poem

🐰 A menu grows, a pointer shines bright,
Docs for the code that runs in the night,
Programmatic paths now clearly defined,
APIs and instances beautifully aligned! ✨

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately describes the main change: adding documentation for programmatic API usage, which aligns with the PR's addition of a Programmatic API menu entry and documentation pointer.
Linked Issues check	✅ Passed	The PR addresses the core objective of issue `#8628` by adding documentation entry for the Programmatic API, enabling discoverability of guidance on programmatic API usage as requested.
Out of Scope Changes check	✅ Passed	All changes are strictly within scope: adding a menu entry and documentation pointer for the Programmatic API, both directly addressing the linked issue `#8628`'s requirement to document the programmatic API.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

coderabbitai

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@docs/sf/guides/plugins/creating-plugins.md`:
- Around line 204-205: The markdown link currently points to
"../../programmatic-api.md" which goes up two levels and breaks the link; update
the href to the correct one-level-up relative path "../programmatic-api.md" in
the link text "Programmatic API" so the link resolves from the
creating-plugins.md document.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

Push a commit to this branch (recommended)
Create a new PR with the fixes

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: a37785f9-493b-46c2-b650-0e8ad4eb843f

📥 Commits

Reviewing files that changed from the base of the PR and between 15071ae and b8deb16.

📒 Files selected for processing (2)

docs/sf/guides/plugins/creating-plugins.md
docs/sf/menu.json

coderabbitai · 2026-04-04T19:05:05Z

+See the [Programmatic API](../../programmatic-api.md) documentation for more details on the `serverless` instance.
+


⚠️ Potential issue | 🟡 Minor

Fix the relative path for the Programmatic API link.

Line 204 currently uses ../../programmatic-api.md, which is likely one level too high from docs/sf/guides/plugins/. This can produce a broken docs link.

🔧 Suggested fix

-See the [Programmatic API](../../programmatic-api.md) documentation for more details on the `serverless` instance. +See the [Programmatic API](../programmatic-api.md) documentation for more details on the `serverless` instance.

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

See the [Programmatic API](../../programmatic-api.md) documentation for more details on the `serverless` instance.

See the [Programmatic API](../programmatic-api.md) documentation for more details on the `serverless` instance.

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed. In `@docs/sf/guides/plugins/creating-plugins.md` around lines 204 - 205, The markdown link currently points to "../../programmatic-api.md" which goes up two levels and breaks the link; update the href to the correct one-level-up relative path "../programmatic-api.md" in the link text "Programmatic API" so the link resolves from the creating-plugins.md document.

tang-vu added 2 commits April 4, 2026 12:02

fix: resolve serverless#8628 — Documentation: Document API for progra…

6e03c77

…mmatic use Fixes serverless#8628 Signed-off-by: Tang Vu <145498528+tang-vu@users.noreply.github.com>

fix: resolve serverless#8628 — Documentation: Document API for progra…

b8deb16

…mmatic use Fixes serverless#8628 Signed-off-by: Tang Vu <145498528+tang-vu@users.noreply.github.com>

coderabbitai bot reviewed Apr 4, 2026

View reviewed changes

czubocha closed this Apr 15, 2026

github-actions bot locked and limited conversation to collaborators Apr 15, 2026

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: resolve #8628 — Documentation: Document API for programmatic use#13483

fix: resolve #8628 — Documentation: Document API for programmatic use#13483
tang-vu wants to merge 2 commits intoserverless:mainfrom
tang-vu:contribai/docs/add-programmatic-api-to-the-documentatio

tang-vu commented Apr 4, 2026 •

edited by coderabbitai bot

Loading

Uh oh!

Mmarzex commented Apr 4, 2026 •

edited

Loading

Uh oh!

coderabbitai bot commented Apr 4, 2026 •

edited

Loading

Walkthrough

Changes

Estimated code review effort

Poem

Uh oh!

coderabbitai bot left a comment

Uh oh!

coderabbitai bot Apr 4, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

		See the [Programmatic API](../../programmatic-api.md) documentation for more details on the `serverless` instance.

	See the [Programmatic API](../../programmatic-api.md) documentation for more details on the `serverless` instance.
	See the [Programmatic API](../programmatic-api.md) documentation for more details on the `serverless` instance.

Conversation

tang-vu commented Apr 4, 2026 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Problem

Solution

Changes

Testing

Summary by CodeRabbit

Uh oh!

Mmarzex commented Apr 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Snyk checks have passed. No issues have been found so far.

Uh oh!

coderabbitai bot commented Apr 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Estimated code review effort

Poem

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

coderabbitai bot Apr 4, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

tang-vu commented Apr 4, 2026 •

edited by coderabbitai bot

Loading

Mmarzex commented Apr 4, 2026 •

edited

Loading

coderabbitai bot commented Apr 4, 2026 •

edited

Loading