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 Mar 12, 2026
Conversation
data/<topic-path>/ ingest paths and add nested-topic examplesdata/<topic-path>/ ingest paths and add nested-topic examples (fixes #18 and #19)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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
Related Issues
Fixes #18
Fixes #19
Changes Made
README.mdingest examples to use topic-aligned paths such as./data/documentation/*.pdf.documentation/tutorialsand matching file locations such as./data/documentation/tutorials/*.pdf.docs/commands.mdto explain the topic-aligneddata/<topic-path>/workflow and nested-topic path format.docs/getting-started.mdexamples to use topic-aligned ingest directories and added a nested child-topic example.CHANGELOG.mdfor the documentation update.Testing Done
Checklist