@plures/praxis

---

@plures/praxis / index / generateDocs

Function: generateDocs()

generateDocs(schema, config): GeneratedDoc[]

Defined in: src/integrations/state-docs.ts:714

Generate documentation from a schema (convenience function)

Parameters

schema

PraxisSchema

The Praxis schema to generate documentation for

config

StateDocsConfig

Generator configuration including project title and output directory

Returns

GeneratedDoc[]

An array of GeneratedDoc objects ready to be written to disk