tiennm99/DocsGPT
1
0 Fork 0
mirror of https://github.com/tiennm99/DocsGPT.git synced 2026-10-14 08:17:34 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: fix grammatical parallelism and clean up markdown links in README (#2606)

Browse Source 
* docs: fix grammatical parallelism and clean up markdown links in README

- Fixed grammatical parallelism in QuickStart ("build" -> "building" and added "are" to "Five options are available").
- Converted raw HTML tags to clean Markdown links in Project Structure.
- Fixed capitalization for "React widget".

* docs(readme): update extensions description in Project Structure

Project Structure: Updated the extensions/ directory description in README.md to accurately reference Chatwoot and the React widget (removing the outdated Discord bot reference per maintainer feedback).Project Structure Links: Converted raw HTML links to clean Markdown link syntax for better maintainability and readability.QuickStart Grammar Fixes: Corrected grammatical parallelism ("build" $\rightarrow$ "building" and added "are" to "Five options are available").
This commit is contained in:
roshanroy-lang authored and GitHub committed 2026-07-23 15:26:13 +05:30
1 parent d2acb40304
commit 9d768715ea
1 file changed
+5 -5
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+5 -5
View File
@@ -107,7 +107,7 @@ A more detailed [Quickstart](https://docs.docsgpt.cloud/quickstart) is available
PowerShell -ExecutionPolicy Bypass -File .\setup.ps1
```
Either script will guide you through setting up DocsGPT. Five options available: using the public API, running locally, connecting to a local inference engine, using a cloud API provider, or build the docker image locally. Scripts will automatically configure your `.env` file and handle necessary downloads and installations based on your chosen option.
Either script will guide you through setting up DocsGPT. Five options are available: using the public API, running locally, connecting to a local inference engine, using a cloud API provider, or building the docker image locally. The scripts will automatically configure your `.env` file and handle necessary downloads and installations based on your chosen option.
**Navigate to http://localhost:5173/**
@@ -132,13 +132,13 @@ Please refer to the [CONTRIBUTING.md](CONTRIBUTING.md) file for information abou
## Project Structure
- Application - Flask app (main application).
- **Application** - Backend Flask application.
- Extensions - Extensions, like react widget or discord bot.
- **Extensions** - Integrations and widgets (e.g., Chatwoot, React widget).
- Frontend - Frontend uses <a href="https://vitejs.dev/">Vite</a> and <a href="https://react.dev/">React</a>.
- **Frontend** - Web UI built with [Vite](https://vitejs.dev/) and [React](https://react.dev/).
- Scripts - Miscellaneous scripts.
- **Scripts** - Miscellaneous utility scripts.
## Code Of Conduct