Skip to content

Add LLM-Friendly Documentation using llmstxt#2285

Open
sundarshankar89 wants to merge 5 commits intomainfrom
feature/add-llmstxt
Open

Add LLM-Friendly Documentation using llmstxt#2285
sundarshankar89 wants to merge 5 commits intomainfrom
feature/add-llmstxt

Conversation

@sundarshankar89
Copy link
Collaborator

@sundarshankar89 sundarshankar89 commented Feb 12, 2026

Summary

Integrates the @signalwire/docusaurus-plugin-llms-txt plugin to generate AI-accessible documentation, making Lakebridge docs discoverable and usable by LLMs and AI-powered tools using standard https://llmstxt.org/

  • Developer Experience
    • Enables AI assistants to access Lakebridge documentation context
    • Improves discoverability through standardized llms.txt format
    • Maintains existing documentation structure without changes

<baseurl>/lakebridge/llms.txt

image

Individual page markdown files will be available at:
https://databrickslabs.github.io/lakebridge/llms.txt

For example:

  • /lakebridge/llms/docs/overview.md
  • /lakebridge/llms/docs/installation.md
  • /lakebridge/llms/docs/assessment/profiler.md
  • /lakebridge/llms/docs/transpile/teradata.md

Functionality

  • added relevant user documentation
  • added new CLI command
  • modified existing command: databricks labs lakebridge ...
  • ... +add your own

Tests

  • manually tested
  • added unit tests
  • added integration tests

@sundarshankar89 sundarshankar89 requested a review from a team as a code owner February 12, 2026 14:19
@sundarshankar89 sundarshankar89 self-assigned this Feb 12, 2026
@sundarshankar89 sundarshankar89 added the documentation Improvements or additions to documentation label Feb 12, 2026
@codecov
Copy link

codecov bot commented Feb 12, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 67.53%. Comparing base (6f52258) to head (aaf5d30).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2285   +/-   ##
=======================================
  Coverage   67.53%   67.53%           
=======================================
  Files          99       99           
  Lines        8837     8837           
  Branches      916      916           
=======================================
  Hits         5968     5968           
  Misses       2694     2694           
  Partials      175      175           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@github-actions
Copy link

github-actions bot commented Feb 12, 2026

✅ 131/131 passed, 8 flaky, 5 skipped, 29m2s total

Flaky tests:

  • 🤪 test_installs_and_runs_local_bladebridge (20.378s)
  • 🤪 test_installs_and_runs_pypi_bladebridge (27.843s)
  • 🤪 test_transpiles_informatica_to_sparksql_non_interactive[True] (17.243s)
  • 🤪 test_transpiles_informatica_to_sparksql_non_interactive[False] (17.704s)
  • 🤪 test_transpile_teradata_sql_non_interactive[True] (19.389s)
  • 🤪 test_transpiles_informatica_to_sparksql (18.422s)
  • 🤪 test_transpile_teradata_sql_non_interactive[False] (6.931s)
  • 🤪 test_transpile_teradata_sql (17.932s)

Running from acceptance #3737

Copy link
Collaborator

@gueniai gueniai left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@sundarshankar89 sundarshankar89 added this pull request to the merge queue Feb 14, 2026
github-merge-queue bot pushed a commit that referenced this pull request Feb 14, 2026
## Summary
Integrates the `@signalwire/docusaurus-plugin-llms-txt` plugin to
generate AI-accessible documentation, making Lakebridge docs
discoverable and usable by LLMs and AI-powered tools using standard
https://llmstxt.org/

  - **Developer Experience**
    - Enables AI assistants to access Lakebridge documentation context
    - Improves discoverability through standardized llms.txt format
    - Maintains existing documentation structure without changes
   
`<baseurl>/lakebridge/llms.txt`

<img width="1506" height="913" alt="image"
src="https://github.com/user-attachments/assets/cea80c36-20a5-4fea-b2e2-55d19e29c4c3"
/>


Individual page markdown files will be available at:
  https://databrickslabs.github.io/lakebridge/llms.txt

  For example:
  - /lakebridge/llms/docs/overview.md
  - /lakebridge/llms/docs/installation.md
  - /lakebridge/llms/docs/assessment/profiler.md
  - /lakebridge/llms/docs/transpile/teradata.md

### Functionality

- [ ] added relevant user documentation
- [ ] added new CLI command
- [ ] modified existing command: `databricks labs lakebridge ...`
- [ ] ... +add your own

### Tests
<!-- How is this tested? Please see the checklist below and also
describe any other relevant tests -->

- [x] manually tested
- [ ] added unit tests
- [ ] added integration tests
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Feb 14, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants