docs: fix README typos and Docker Compose syntax - #6
Merged
KarimTamani merged 1 commit intoAug 4, 2026
Merged
Conversation
Correct the "Welcome" heading typo and reword "Index Suggestions" in the feature list. The intro now lists all six exportable SQL dialects (adding Oracle and SQL Server) so it matches the Supported Databases section. Add the port 3000 dev-server URL to the local setup instructions, and switch the Docker Compose commands in README and DOCKER.md from the deprecated V1 "docker-compose" to the current V2 "docker compose" syntax.
KarimTamani
approved these changes
Aug 4, 2026
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
2 participants
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.
Description
Documentation-only fixes to
README.mdandDOCKER.md:Welcomtypo in the main heading (Welcome).Indices SuggestionstoIndex Suggestionsin the feature list.npm run devinstructions.README.mdandDOCKER.mdfrom the deprecated V1docker-composeto the current V2docker composesyntax. Filename references todocker-compose.ymlare intentionally left unchanged.Related Issues
None.
Changes Made
Testing
No code changes, so there is no runtime behavior to test. Verification was limited to reviewing the rendered Markdown and confirming the documented facts:
npm run devserves onhttp://localhost:3000(pervite.config.ts), matching the newly added URL.src/utils/importandsrc/utils/render/database.docker compose(V2) is the current supported CLI form;docker-compose.ymlfilename references were preserved.Checklist
Before submitting, please ensure you have:
Additional Notes
Docs-only change with no functional impact.