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.
This pull request significantly restructures and expands the documentation for the NL2SQL platform, focusing on making adapter development and supported database connectivity clearer and more comprehensive. It removes high-level architectural and indexing documentation from the main docs and replaces it with detailed, adapter-focused guides and references. The README is also removed, likely in favor of more targeted documentation.
Documentation Restructuring and Expansion:
README.mdfile, which previously provided an overview, installation instructions, and architectural diagrams.Adapter Documentation Overhaul:
docs/adapters/development.mdguide detailing how to build custom adapters, including required interfaces, compliance testing, and when to use base classes likeDatasourceAdapterorBaseSQLAlchemyAdapter.docs/adapters/index.mdas the main entry point for adapter documentation, listing supported SQL adapters and providing configuration examples.Per-Adapter Documentation: