Skip to content

Docs: use topic-aligned data/<topic-path>/ ingest paths and add nested-topic examples (fixes #18 and #19)#44

Merged
virginia-delos merged 2 commits intomainfrom
codex/create-pr-for-issue-18-cpt0n8
Mar 12, 2026
Merged

Docs: use topic-aligned data/<topic-path>/ ingest paths and add nested-topic examples (fixes #18 and #19)#44
virginia-delos merged 2 commits intomainfrom
codex/create-pr-for-issue-18-cpt0n8

Conversation

@nsuruguay05
Copy link
Contributor

@nsuruguay05 nsuruguay05 commented Mar 12, 2026

Description

Updates the documentation to use topic-aligned ingest file paths under data/<topic-path>/ and adds nested-topic ingestion examples so the documented file layout matches the topic hierarchy used by the Content API.

Type of Change

  • Bug fix (non-breaking change that fixes an issue)
  • New feature (non-breaking change that adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation update
  • Refactoring (no functional changes)

Related Issues

Fixes #18
Fixes #19

Changes Made

  • Updated README.md ingest examples to use topic-aligned paths such as ./data/documentation/*.pdf.
  • Added nested-topic ingest examples using slash-separated topic paths such as documentation/tutorials and matching file locations such as ./data/documentation/tutorials/*.pdf.
  • Updated docs/commands.md to explain the topic-aligned data/<topic-path>/ workflow and nested-topic path format.
  • Updated docs/getting-started.md examples to use topic-aligned ingest directories and added a nested child-topic example.
  • Added a changelog entry in CHANGELOG.md for the documentation update.

Testing Done

  • Unit tests pass locally
  • Added new tests for new functionality
  • Tested manually

Checklist

  • My code follows the project's style guidelines
  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • New and existing unit tests pass locally with my changes

Clarify where to place documents for ingestion and update examples to use data/<topic-path> paths, including nested child topics.\n\nFixes #18\nFixes #19
@nsuruguay05 nsuruguay05 changed the title Docs: use topic-aligned data/<topic-path>/ ingest paths and add nested-topic examples Docs: use topic-aligned data/<topic-path>/ ingest paths and add nested-topic examples (fixes #18 and #19) Mar 12, 2026
@virginia-delos virginia-delos self-requested a review March 12, 2026 15:07
@virginia-delos virginia-delos merged commit cb82975 into main Mar 12, 2026
13 checks passed
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.

[BUG] Fix incorrect ingestion path in the "Quick start Guide" [FEATURE] Add example for ingesting documents into nested (child) topics

2 participants