Add beta Documentation

This commit is contained in:
2026-05-22 09:04:42 +02:00
parent 37bec89484
commit 29bd42e52e
255 changed files with 704332 additions and 0 deletions
@@ -0,0 +1 @@
{"path":"NexusReader.Domain/Entities/Ebook.cs","purpose":"Defines the domain entity Ebook with storage/ORM mapping, metadata, navigation properties (Author, NexusUser), and fields used for reading/progress and AI ingestion readiness.","classification":{"role":"entity","layer":"domain","confidence":0.9,"evidence":["Domain/entity pattern","Domain path heuristic","namespace NexusReader.Domain.Entities; (line 4)","Entity class Ebook with data annotations like [Key], [Required], [ForeignKey] (lines 11, 14, 21, 24, 29, 53, 56)","Contains domain properties and navigation properties Author and NexusUser (lines 21-22, 56-57)"]},"className":"Ebook","methods":[],"types":[{"name":"Ebook","kind":"entity","line":9,"purpose":"Represents an e-book owned/uploaded by a user including metadata, storage info, reading progress and AI ingestion state.","fields":[{"name":"Id","type":"Guid","required":true,"line":11,"description":"Primary key; initialized to a new Guid"},{"name":"Title","type":"string","required":true,"line":14,"description":"Book title; max length 255"},{"name":"AuthorId","type":"int","required":true,"line":18,"description":"Foreign key to Author"},{"name":"Author","type":"Author (navigation)","required":true,"line":21,"description":"Navigation property to Author (ForeignKey(nameof(AuthorId)))"},{"name":"FilePath","type":"string","required":true,"line":24,"description":"Path to stored ebook file"},{"name":"CoverUrl","type":"string?","required":false,"line":27,"description":"Optional cover image URL"},{"name":"TenantId","type":"string","required":true,"line":29,"description":"Tenant identifier (multi-tenant); max length 128; defaults to \"global\""},{"name":"AddedDate","type":"DateTime","required":true,"line":33,"description":"Creation/added timestamp; defaults to DateTime.UtcNow"},{"name":"LastReadDate","type":"DateTime?","required":false,"line":35,"description":"Nullable timestamp for last time read"},{"name":"Progress","type":"double","required":true,"line":37,"description":"Reading progress percentage (0..100); defaults to 0"},{"name":"LastChapter","type":"string?","required":false,"line":39,"description":"Optional last chapter title; max length 255"},{"name":"LastChapterIndex","type":"int","required":true,"line":42,"description":"Index of last read chapter; defaults to 0"},{"name":"Description","type":"string?","required":false,"line":44,"description":"Optional description or synopsis"},{"name":"IsReadyForReading","type":"bool","required":true,"line":50,"description":"Flag indicating AI ingestion/processing completed and knowledge units are available"},{"name":"UserId","type":"string","required":true,"line":53,"description":"Owner user id (required)"},{"name":"User","type":"NexusUser? (navigation)","required":false,"line":56,"description":"Optional navigation to NexusUser (ForeignKey(nameof(UserId)))"}]}],"serviceRegistrations":[],"startupActions":[],"dependencies":["NexusReader.Domain.Entities.Author","NexusReader.Domain.Entities.NexusUser"],"patterns":["ORM Entity","Repository (consumer)"],"domainConcepts":["Ebook","Author","NexusUser","Tenant","AI ingestion / Knowledge Units"],"keyDetails":"Entity includes multi-tenant TenantId defaulting to 'global', navigation properties for Author and NexusUser, and an IsReadyForReading flag indicating AI processing state used by ingestion/reading flows.","orchestrationMethods":[],"typedContracts":[{"name":"Ebook","kind":"entity","line":9,"fieldCount":16,"evidencePaths":["NexusReader.Domain/Entities/Ebook.cs"]}],"persistenceInteractions":[],"externalInteractions":[],"evidenceAnchors":[{"kind":"typed-contract","label":"Ebook","line":9,"summary":"entity with 16 fields.","confidence":0.8,"evidencePaths":["NexusReader.Domain/Entities/Ebook.cs"]}]}