Skip to content

Latest commit

 

History

History
23 lines (19 loc) · 1.87 KB

File metadata and controls

23 lines (19 loc) · 1.87 KB

Documentation Index

This directory is the canonical home for fdnext usage, maintenance, and rule-authoring documentation. The root README stays as a product and package overview.

Document Scope
Integration guide SDK setup, browser resources, server startup, and deployment notes
Server API Canonical HTTP routes, query parameters, response contract, status behavior, and CORS rules
Cloudflare Workers deployment Wrangler config, local dev, deployment, and Worker-specific External Link notes
FDBGen documentation FDB generation, MDB crawling, raw input layout, cleanup rules, and crawler behavior
fdnext fdbgen v1 support list Standard post-extraction support-list JSON format for fdbgen import tools
DecodePack specification PN and typed identifier iTXTech fdnext DecodePack authoring, output fields, and validation commands
PN code reference index Vendor/product-line PN reference documents and maintenance boundaries
PN reference confidence policy Rule admission tiers and where source-confidence metadata may live
Cross-vendor terminology Canonical public field keys and display terminology

Documentation boundaries:

  • Keep root README.md and README-zh.md overview-only.
  • Put integration, runtime, HTTP API, and maintenance procedures in this docs/ directory.
  • Keep shared server interface facts in SERVER_API.md; platform deployment guides should link to it instead of duplicating route tables.
  • Put vendor-specific PN structures, source notes, token tables, and examples in docs/pn_code/<vendor>_<product>.md.
  • Put source-confidence rules in docs/pn_code/reference_policy.md and public field naming in docs/pn_code/terminology.md.