Skip to content

Add documentation index and metadata/errors reference#7

Merged
asukhodko merged 1 commit into
mainfrom
codex/add-documentation-for-navigation-and-errors
Jan 9, 2026
Merged

Add documentation index and metadata/errors reference#7
asukhodko merged 1 commit into
mainfrom
codex/add-documentation-for-navigation-and-errors

Conversation

@asukhodko

Copy link
Copy Markdown
Owner

Motivation

  • Provide a single entry point for the docs with a navigational map to make discovery easier.
  • Surface a concise metadata reference describing Chunk fields and key chunk.metadata entries (e.g. header_path, content_type, strategy, overlaps, chunk_id, line ranges).
  • Offer a short troubleshooting guide covering primary exception types (ChunkanaError, ValidationError, HierarchicalInvariantError, ConfigurationError) and practical tips.
  • Update existing entry points so README and Overview point to the new pages.

Description

  • Add docs/index.md as a documentation index and navigation hub with short summaries.
  • Add docs/metadata.md documenting Chunk top-level fields and important chunk.metadata keys and overlap semantics.
  • Add docs/errors.md with explanations and troubleshooting tips for the main Chunkana exceptions.
  • Update README.md and docs/overview.md to link to the new docs/index.md, docs/metadata.md, and docs/errors.md pages.

Testing

  • No automated tests were run because these are documentation-only changes.

Codex Task

@asukhodko asukhodko merged commit d95889e into main Jan 9, 2026
1 check passed
@asukhodko asukhodko deleted the codex/add-documentation-for-navigation-and-errors branch January 9, 2026 07:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant