Skip to content

[Nexthop] Simplify and improve PlatformManager documentation#1078

Open
marif-nexthop wants to merge 2 commits intofacebook:mainfrom
nexthop-ai:marif.fboss-platform-docs-improve
Open

[Nexthop] Simplify and improve PlatformManager documentation#1078
marif-nexthop wants to merge 2 commits intofacebook:mainfrom
nexthop-ai:marif.fboss-platform-docs-improve

Conversation

@marif-nexthop
Copy link
Copy Markdown
Contributor

Pre-submission checklist

  • I've ran the linters locally and fixed lint errors related to the files I modified in this PR. You can install the linters by running pip install -r requirements-dev.txt && pre-commit install
  • pre-commit run

Summary

This PR streamlines the PlatformManager documentation by reducing redundant content, improving readability, and pointing readers toward source code where appropriate. The previous PR in this series was #943.

  • Consolidated Presence Detection docs - Moved the introduction into modeling.md and removed the separate page.
  • Simplified Service API documentation - Reduced verbose descriptions and directed readers to the Thrift file in code instead.
  • Replaced static argument lists with --help - Removed the manually maintained list of PlatformManager arguments in favor of a pointer to --help, ensuring docs don't go stale.
  • Replaced inline enum lists with a link to code - Removed hardcoded enum values and linked to the source file directly.
  • Improved formatting and readability - Added info and tip blocks to highlight key information and improve visual scannability. Minor wording tweaks throughout.

Test Plan

Deployed a local docusaurus instance with the new documentation and verified that changes look as expected.

Signed-off-by: marif-nexthop <marif@nexthop.ai>
@marif-nexthop marif-nexthop requested a review from a team as a code owner April 14, 2026 19:40
@meta-cla meta-cla Bot added the CLA Signed label Apr 14, 2026
Copy link
Copy Markdown
Contributor

@Scott8440 Scott8440 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for doing this!


PMUnit presence bits must be managed by the chips present in the parent PMUnit.

### Presence Detection
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You could link to the thrift struct for presence detection here

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done in the latest diff.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants