chore: rewrite docs #491
Merged
chore: rewrite docs #491
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
juleswritescode
approved these changes
Sep 9, 2025
docs/features/syntax_diagnostics.md
Outdated
|
|
||
| ## How it Works | ||
|
|
||
| The language server uses [libpg_query](https://github.com/pganalyze/libpg_query) to parse SQL statements, which is the actual Postgre parser packaged as a library. This ensures 100% compatibility with Postgres syntax. |
There was a problem hiding this comment.
Suggested change
| The language server uses [libpg_query](https://github.com/pganalyze/libpg_query) to parse SQL statements, which is the actual Postgre parser packaged as a library. This ensures 100% compatibility with Postgres syntax. | |
| The language server uses [libpg_query](https://github.com/pganalyze/libpg_query) to parse SQL statements, which is the actual Postgres parser packaged as a library. This ensures 100% compatibility with Postgres syntax. |
docs/features/syntax_diagnostics.md
Outdated
| ## Features | ||
|
|
||
| - Always correct: Uses the same parser as Postgres itself for accurate syntax validation | ||
| - Named Parameter Support: Postgres does not support named parameters such as `:param` and `@param`. Since they are commonly used in ORMs and other tooling, we convert them to positional parameters (`$1`, `$2`) before parsing |
There was a problem hiding this comment.
This reads as though the feature is not supported, maybe:
"Named Parameter Support: We convert :param and @param to positional parameters ($1, $2) so the Postgres parsers understands them and the LSP works with ORMs and other tooling
docs/features/syntax_diagnostics.md
Outdated
|
|
||
| ## Error Information | ||
|
|
||
| Syntax errors include: |
There was a problem hiding this comment.
Suggested change
| Syntax errors include: | |
| Syntax errors include: |
docs/features/syntax_diagnostics.md
Outdated
| ## Error Information | ||
|
|
||
| Syntax errors include: | ||
| - The exact error message from the Postgres parser |
There was a problem hiding this comment.
Suggested change
| - The exact error message from the Postgres parser | |
| - The exact error message from the Postgres parser |
docs/features/syntax_diagnostics.md
Outdated
|
|
||
| Syntax errors include: | ||
| - The exact error message from the Postgres parser | ||
| - Source location when available (though `libpg_query` does not always provide precise positions) |
There was a problem hiding this comment.
Suggested change
| - Source location when available (though `libpg_query` does not always provide precise positions) | |
| - Source location when available (though `libpg_query` does not always provide precise positions) |
| } | ||
| ``` | ||
|
|
||
| The `searchPath` supports: |
There was a problem hiding this comment.
ok die liste hier ist auch nicht korrekt formiert, grundsätzlich müssen bei fast allen listen noch spaces hinzugefügt werden glaub ich
docs/features/type_checking.md
Outdated
| - Glob patterns (e.g., `"app_*"` to match `app_users`, `app_products`, etc.) | ||
| - The order matters - schemas are searched in the order specified | ||
|
|
||
| If not configured, defaults to `["public"]`. |
There was a problem hiding this comment.
Suggested change
| If not configured, defaults to `["public"]`. | |
| Even if not specified, the LSP will always search`"public"` in last position. |
docs/guides/vcs_integration.md
Outdated
Comment on lines
3
to
4
| The VCS (Version Control System) integration is meant to take advantage of additional features that only a VCS can provide. The integration is opt-in. You have to enable `vcs.enabled` and set `vcs.clientKind` in the configuration file: | ||
|
|
There was a problem hiding this comment.
maybe a quick sentence regarding what those features are?
docs/guides/workspace_support.md
Outdated
docs/guides/ide_setup.md
Outdated
Comment on lines
53
to
55
| >![Note] | ||
| > If you decide to use the daemon, you’re also responsible to restart/kill the process with the stop command, to avoid having ghost processes. | ||
| Caution |
There was a problem hiding this comment.
das formatiert nicht richtig
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.
I think this is best reviewed locally via
just serve-docs.its time to improve here… will rewrite the documentation based on the new structure over the next days.
the goal is to show the features we support better. right now, they are hidden in the main index page. will add example gifs etc to the feature pages too.
progress