Split documentation into granular category-specific resources (#69) #74
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
Replaces the monolithic resource://mapbox-documentation with five focused resources for better performance and organization: - resource://mapbox-api-reference - REST API documentation - resource://mapbox-sdk-docs - SDK and client library docs - resource://mapbox-guides - Tutorials and how-tos - resource://mapbox-examples - Code examples and playgrounds - resource://mapbox-reference - Reference materials (tilesets, data products) This allows AI assistants and clients to fetch only the documentation category they need, improving performance and reducing context window usage. The original resource://mapbox-documentation is kept for backward compatibility with a deprecation notice. Implementation details: - Created shared docParser utility for parsing and categorizing sections - Added comprehensive tests for parser and new resources - All 553 tests passing Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
Resolves #69
Replaces the monolithic
resource://mapbox-documentationwith five focused, category-specific resources for better performance and organization:resource://mapbox-api-reference- REST API documentationresource://mapbox-sdk-docs- SDK and client library documentationresource://mapbox-guides- Tutorials, how-tos, and guidesresource://mapbox-examples- Code examples and API playgroundsresource://mapbox-reference- Reference materials (tilesets, data products, etc.)This allows AI assistants and MCP clients to fetch only the documentation category they need, improving:
The original
resource://mapbox-documentationis kept for backward compatibility with a deprecation notice.Implementation
docParserutility (src/resources/utils/docParser.ts) for parsing and categorizing documentation sectionsresourceRegistry.tsMapboxDocumentationResourceTest Results
test/resources/utils/docParser.test.ts- 12 tests for parser utilitytest/resources/mapbox-api-reference-resource/MapboxApiReferenceResource.test.ts- 5 tests for resource classBreaking Changes
None - the original
resource://mapbox-documentationcontinues to work for backward compatibility.🤖 Generated with Claude Code