[PR #7020] [doc] Agent network docs update #27831

Open
opened 2026-08-05 07:09:17 -04:00 by saavagebueno · 0 comments
Owner

Original Pull Request: https://github.com/netbirdio/netbird/pull/7020

State: open
Merged: No


Describe your changes

Docs were stale for the new pricing architecture.
The code/OpenAPI were updated, but the agent-network docs still describe proxy-side pricing.Loader, pricing_path, MiddlewareDataDir, embedded defaults, and symlink-safe proxy
loading in docs/agent-networks/modules/31-proxy-middleware-builtin.md:171, docs/agent-networks/modules/32-proxy-llm-parsers.md:27, and docs/agent-networks/modules/33-proxy-
runtime.md:4. These should describe management-owned pricing, the new pricing config payload, and AgentNetwork.PricingDefaultsFile.

Stack

Checklist

  • Is it a bug fix
  • Is a typo/documentation fix
  • Is a feature enhancement
  • It is a refactor
  • Created tests that fail without the change (if possible)
  • I ran and tested this change locally — I did not rely on CI to find out whether it works
  • This PR has a single purpose (not a fix + refactor + feature in one)
  • This change is a trivial fix, OR it links an issue the NetBird team agreed on beforehand. Changes to the public API, gRPC protocols, functionality behavior, CLI / service flags, or new features always need that agreement first. See CONTRIBUTING.md.

By submitting this pull request, you confirm that you have read and agree to the terms of the Contributor License Agreement.

Documentation

Select exactly one:

  • I added/updated documentation for this change
  • Documentation is not needed for this change (explain why)

Docs PR URL (required if "docs added" is checked)

Paste the PR link from https://github.com/netbirdio/docs here:

https://github.com/netbirdio/docs/pull/__

Summary by CodeRabbit

  • Documentation

    • Updated agent-network documentation to describe management-delivered, configuration-based LLM pricing.
    • Clarified pricing tables, provider defaults, validation, cost breakdowns, fallback behavior, and normalized model handling.
    • Documented middleware configuration delivery and updated compatibility guidance.
    • Added guidance for regional and catalog-driven pricing, including unknown-model behavior.
    • Clarified that pricing is delivered through configuration rather than standalone files.
  • Style

    • Standardized references to “open source” across project, contribution, security, funding, and API documentation.
**Original Pull Request:** https://github.com/netbirdio/netbird/pull/7020 **State:** open **Merged:** No --- ## Describe your changes Docs were stale for the new pricing architecture. The code/OpenAPI were updated, but the agent-network docs still describe proxy-side pricing.Loader, pricing_path, MiddlewareDataDir, embedded defaults, and symlink-safe proxy loading in docs/agent-networks/modules/31-proxy-middleware-builtin.md:171, docs/agent-networks/modules/32-proxy-llm-parsers.md:27, and docs/agent-networks/modules/33-proxy- runtime.md:4. These should describe management-owned pricing, the new pricing config payload, and AgentNetwork.PricingDefaultsFile. ## Issue ticket number and link <!-- Required for anything that changes behavior. Link the issue (or the validated discussion it came from) that the NetBird team already agreed on. See https://github.com/netbirdio/netbird/blob/main/CONTRIBUTING.md#ticket-first-pr-second --> ## Stack <!-- branch-stack --> ### Checklist - [ ] Is it a bug fix - [x] Is a typo/documentation fix - [ ] Is a feature enhancement - [ ] It is a refactor - [ ] Created tests that fail without the change (if possible) - [ ] I ran and tested this change locally — I did not rely on CI to find out whether it works - [ ] This PR has a single purpose (not a fix + refactor + feature in one) - [ ] This change is a trivial fix, **OR** it links an issue the NetBird team agreed on beforehand. Changes to the public API, gRPC protocols, functionality behavior, CLI / service flags, or new features always need that agreement first. See [CONTRIBUTING.md](https://github.com/netbirdio/netbird/blob/main/CONTRIBUTING.md#ticket-first-pr-second). > By submitting this pull request, you confirm that you have read and agree to the terms of the [Contributor License Agreement](https://github.com/netbirdio/netbird/blob/main/CONTRIBUTOR_LICENSE_AGREEMENT.md). ## Documentation Select exactly one: - [ ] I added/updated documentation for this change - [x] Documentation is **not needed** for this change (explain why) ### Docs PR URL (required if "docs added" is checked) Paste the PR link from https://github.com/netbirdio/docs here: https://github.com/netbirdio/docs/pull/__ <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit - **Documentation** - Updated agent-network documentation to describe management-delivered, configuration-based LLM pricing. - Clarified pricing tables, provider defaults, validation, cost breakdowns, fallback behavior, and normalized model handling. - Documented middleware configuration delivery and updated compatibility guidance. - Added guidance for regional and catalog-driven pricing, including unknown-model behavior. - Clarified that pricing is delivered through configuration rather than standalone files. - **Style** - Standardized references to “open source” across project, contribution, security, funding, and API documentation. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
saavagebueno added the pull-request label 2026-08-05 07:09:17 -04:00
Sign in to join this conversation.
No Label pull-request
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: DYNR/netbird#27831