Repository navigation
docs: fix outdated guides, document browser, Nix and Eglot setups, and check docs in CI - #876
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.
Fixes several docs pages that tell users to do things that don't work, and adds the setup docs people kept asking for in GitHub Discussions. Only docs and
mkdocs.ymlchange.Corrections
--skip-dbdoesn't exist, so it's now--disable-db. The action is nowsupabase-community/postgres-language-server-cli-actioninstead of the oldpglt-cli-actionname. Also adds a format check job:formatwithout--writeexits non-zero when a file would change.allowStatementExecutionsAgainstwas documented as a list of schemas. It's a list of glob patterns matched againsthost/database(crates/pgls_workspace/src/settings.rs), so a config copied from the guide never enabled execution:$name,:name,:'name',:"name",@name). The page used to list only:nameand@name.Editor setup
vim.lsp.enable('postgres_lsp')for 0.11+, with the legacyrequire('lspconfig')call kept for older versions. Also notes that the nvim-lspconfig preset setsworkspace_required = truewithpostgres-language-server.jsoncas root marker, so the server doesn't start untilpostgres-language-server inithas created that file. This was the usual reason for "the server doesn't attach".lsp-postgresclient and adds an Eglot snippet.postgres-language-server.jsoncper workspace folder.configuration.mdgets a new section onextendsfor shared settings, which wasn't documented before (path resolution and precedence as implemented inapply_extends). Nested per-directory configs are left out because they're in a separate PR.New pages
postgres-language-serverpackage.guides/browser.md: running@postgres-language-server/wasmin a web worker, with Monaco (monaco-languageclient) and CodeMirror (@codemirror/lsp-client), and loading the schema withschema-export+pgls/setSchema. The package APIs come from its README andsrc/; the third-party client APIs (MonacoLanguageClient, the CodeMirrorTransport) were checked against their upstream sources. The Monaco example leaves Monaco service setup to the monaco-languageclient docs, because it differs between versions.External names were checked against upstream: the action repo, nvim-lspconfig's
lsp/postgres_lsp.lua, lsp-mode'sclients/lsp-postgres.el, and nixpkgs'pkgs/by-name/po/postgres-language-server.zensical build --strictpasses.CI on docs changes
The
Pull Requestworkflow ignored docs, so docs PRs (including this one) ran no checks, and the site was only built after merging. It now also triggers ondocs/**,mkdocs.yml,pyproject.tomlanduv.lock. ADetect Changesjob (dorny/paths-filter) splits code from docs changes:Format,Check Codegen(it regenerates the rule docs, the CLI reference and the default configuration, so it catches edits to generated sections), and a newBuild Docsjob runningzensical build --strict. Strict mode fails on broken links: I verified that a dead link aborts the build.workflow_dispatch) run every job.Addresses: