UseDocumentationConfigReturn

reference

1 min readUpdated 2026-07-28

Kind: Interface

Source: atloria-monorepo/apps/web/src/hooks/useDocumentationConfig.ts

Hook return type

Properties

Property	Type
`config`	`DocumentationConfig
`loading`	`boolean`
`error`	`Error
`hasConfig`	`boolean`
`localSkeleton`	`SkeletonStructure
`isDirty`	`boolean`
`loadConfig`	`() => Promise<DocumentationConfig
`createConfig`	`(data: CreateConfigDto) => Promise<DocumentationConfig>`
`updateConfig`	`(data: UpdateConfigDto) => Promise<DocumentationConfig>`
`deleteConfig`	`() => Promise<void>`
`addCategory`	`(category: Omit<SkeletonCategory, 'documents'>) => void`
`removeCategory`	`(slug: string) => void`
`updateCategory`	`(slug: string, updates: Partial<Omit<SkeletonCategory, 'documents'>>) => void`
`addDocument`	`(categorySlug: string, document: SkeletonDocument) => void`
`removeDocument`	`(categorySlug: string, documentSlug: string) => void`
`updateDocument`	`(categorySlug: string, documentSlug: string, updates: Partial<SkeletonDocument>) => void`
`reorderCategories`	`(categoryIds: string[]) => void`
`reorderDocuments`	`(categorySlug: string, documentSlugs: string[]) => void`
`resetLocalChanges`	`() => void`
`saveLocalChanges`	`() => Promise<DocumentationConfig>`