Client Guide Maintenance Policy
Client software updates continuously, and interfaces and configuration parameters may change over time. This document outlines the maintenance and verification mechanisms for integration guides, as well as feedback channels for outdated content.
Last Verified
Every client integration guide carries a "Last verified" date recording the most recent check against a real client. The date alone does not identify the systems, versions, or setup paths tested; read the verification scope below it too.
Historical pages with only a date display "Verification scope not recorded". This does not mean every branch was tested. App / CLI variants, systems, and optional features not listed in the scope require separate compatibility checks.
The "Last updated" line in the footer is a different thing: it comes from the Git commit time, so fixing a typo refreshes it. To judge whether the content keeps up with the client, read "Last verified".
Verification Cycle
The target is at least one verification every 30 days. Each pass checks:
| Item | What is checked |
|---|---|
| Installation | Whether the commands, package names, and download links still work |
| Setting names | Client redesigns frequently rename or move settings |
| Screenshots | Whether they match the current interface |
| Verification steps | Whether the commands in the guide still return what they should |
Major client releases should trigger an extra verification pass without waiting for the cycle.
Recording Verification Scope
After testing a real client, update verifiedAt in the page frontmatter and use verifiedWith to record the full client version, operating system and version, setup method, and successfully tested features. verifiedWith is a string displayed below the verification date. Chinese and English pages should record the same facts.
Verification must include a real model reply; a successful installation or model-list request is not proof of inference working. If only some branches pass, record only that scope and mark the remaining branches as unverified in the body. Wording edits, documentation builds, and translation updates must not refresh the verification date.
Scope
This policy covers the Agents and ChatBot integration guides.
Billing, error codes, and API endpoint pages carry no verification date. They track changes to Flux itself and are updated alongside them.
Reporting Stale Content
When a guide no longer matches reality, please report it using the template in Troubleshooting, including the client version. The same guide can behave completely differently across versions.
Related Pages
- Quickstart - pick an integration path by client
- Troubleshooting - locate a problem by symptom