Repository navigation
Conversation
A Starlight site in docs/, deployed to GitHub Pages like anchor's: start-here pages (install, quickstart, connecting clients), guides (read-only logins, working with agents, deployment, logging, development), references for the tools, configuration and HTTP endpoints, and how queries stay read-only. The README now gives the overview and links to the site for the detail it used to carry.
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.
sql-mcp's only documentation was a 468-line README. This adds a Starlight site in
docs/, built and deployed the same way as anchor's, and served at https://fuseraft.ai/sql-mcp/ once merged. GitHub Pages is already turned on for the repo, with GitHub Actions as its source.Pages
README. It now gives the overview, install, configure and connect, and links to the site for the rest, like anchor's.
Workflow.
.github/workflows/docs.ymlis anchor's, withmasterformain. Pull requests that touchdocs/build the site, and pushes tomasterdeploy it.I checked behavior the pages describe against the code and a running server:
/api/queryproblem response, the 403 for a foreignOrigin, and settings on the command line (--App:MaxRows=2);launchSettings.json).The site builds cleanly, and every internal link and
#anchorresolves. I looked at the landing page and a reference page in a browser.