TRUEREF-0023 rewrite indexing pipeline - parallel reads - serialized writes
This commit is contained in:
20
README.md
20
README.md
@@ -214,16 +214,16 @@ For GitHub repositories, TrueRef fetches the file from the default branch root.
|
||||
|
||||
### Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
|---|---|---|---|
|
||||
| `$schema` | string | No | URL to the live JSON Schema for editor validation |
|
||||
| `projectTitle` | string | No | Display name override (max 100 chars) |
|
||||
| `description` | string | No | Library description used for search ranking (10–500 chars) |
|
||||
| `folders` | string[] | No | Path prefixes or regex strings to **include** (max 50 items). If absent, all folders are included |
|
||||
| `excludeFolders` | string[] | No | Path prefixes or regex strings to **exclude** after the `folders` allowlist (max 50 items) |
|
||||
| `excludeFiles` | string[] | No | Exact filenames to skip — no path, no glob (max 100 items) |
|
||||
| `rules` | string[] | No | Best-practice rules prepended to every `query-docs` response (max 20 rules, 5–500 chars each) |
|
||||
| `previousVersions` | object[] | No | Version tags to register when the repository is indexed (max 50 entries) |
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------ | -------- | -------- | ------------------------------------------------------------------------------------------------- |
|
||||
| `$schema` | string | No | URL to the live JSON Schema for editor validation |
|
||||
| `projectTitle` | string | No | Display name override (max 100 chars) |
|
||||
| `description` | string | No | Library description used for search ranking (10–500 chars) |
|
||||
| `folders` | string[] | No | Path prefixes or regex strings to **include** (max 50 items). If absent, all folders are included |
|
||||
| `excludeFolders` | string[] | No | Path prefixes or regex strings to **exclude** after the `folders` allowlist (max 50 items) |
|
||||
| `excludeFiles` | string[] | No | Exact filenames to skip — no path, no glob (max 100 items) |
|
||||
| `rules` | string[] | No | Best-practice rules prepended to every `query-docs` response (max 20 rules, 5–500 chars each) |
|
||||
| `previousVersions` | object[] | No | Version tags to register when the repository is indexed (max 50 entries) |
|
||||
|
||||
`previousVersions` entries each require a `tag` (e.g. `"v1.2.3"`) and a `title` (e.g. `"Version 1.2.3"`).
|
||||
|
||||
|
||||
Reference in New Issue
Block a user