feat: add document discovery and search - #2
Merged
Merged
Conversation
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.
What changed
parseDoc,getDocument,listSections, andsearchas supported public APIs@nbtca/docs@0.3.0and keep the README focused on the public contractWhy
Consumers previously had to rebuild document parsing, routing, section discovery, and search around raw GitHub files. The expanded client centralizes those semantics so Prompt and other consumers can share one tested document model, including the latest components used by
nbtca/documents.Impact
This is a backward-compatible minor release. Existing
listDir,listAll, andgetFileconsumers continue to work, while consumers can opt into richer discovery and search APIs. The published package remains renderer-agnostic and contains only runtime output, types, the README, license, and package manifest.Validation
npm run checknpm audit --audit-level=moderatefound 0 vulnerabilitiesnpm publish --dry-runprepublishOnlygate@nbtca/docs@0.3.0, 13 published files, and a 10.1 kB tarballThis draft does not merge, tag, or publish the release.