- Notifications
You must be signed in to change notification settings - Fork109
chore: rewrite docs#491
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Uh oh!
There was an error while loading.Please reload this page.
Conversation
juleswritescode left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
sehr sehr nice :)
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
| The language server uses[libpg_query](https://github.com/pganalyze/libpg_query) to parse SQL statements, which is the actualPostgre 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 actualPostgres 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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
This reads as though the feature isnot 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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
| 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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
| - 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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
| - 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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
| Ifnotconfigured, defaults to`["public"]`. | |
| Even ifnotspecified, the LSP will always search`"public"` in last position. |
docs/guides/vcs_integration.md Outdated
| 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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
maybe a quick sentence regarding what those features are?
docs/guides/workspace_support.md Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
placeholder? :P
docs/guides/ide_setup.md Outdated
| >![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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
das formatiert nicht richtig
Uh oh!
There was an error while loading.Please reload this page.
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