Farther ShoreDocs
Go to Farther Shore
Getting startedCore conceptsLaunch checklist
ProductsUpstream routingEnvironmentsDeveloper portals
Billing strategiesPlans and limitsSubscribersAPI keys
Gateway enforcementUsage meteringLimits and creditsGateway sharding
Launch a request-counted product15mAdd monthly included usageAdd subscription plus overageCreate a prepaid credits productMeter AI token usageAdd a custom meterIssue and test an API keyDebug a denied requestUpdate product docsPrepare for launch
TroubleshootingGateway response codesMeter namingPlatform docs publishing
Status
Docs/Cookbook/Update product docs

Update product docs

Publish managed docs for a product without changing platform docs.

PreviousDebug a denied requestNextPrepare for launch

On this page

When to update product docsRecommended product docs structurePublish modelValidation

Product docs explain a specific API product. They are separate from these platform docs.

When to update product docs

Update product docs when:

  • endpoints change
  • examples change
  • authentication instructions change
  • plan limits change
  • billing units change
  • response codes change

Recommended product docs structure

Overview
Authentication
Quickstart
Endpoints
Errors
Usage and billing
Changelog

Publish model

Managed product docs are published under product-specific prefixes:

docs/{productId}/...
docs/{productId}/env/{envName}/...

The public platform docs are published under:

platform/docs/...

Keep these content sets separate. Product docs should not explain how Farther Shore itself works except where subscribers need to know how to authenticate, read usage, or understand billing.

Validation

Before publishing product docs:

  • run every curl example
  • verify plan names and limits match the portal
  • verify auth header examples use subscriber API keys
  • verify links point to existing product pages
  • preview stage docs before production when possible