You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Fix Windows User Only: Automatic docker-compose.yml Fix in docker-start.bat
Added code to automatically fix the docker-compose.yml file for Windows users
The script now copies the content from docker/compose/docker-compose.yml to ensure proper formatting
This happens transparently every time docker-start.bat is run
The fix addresses line ending issues and encoding problems that can cause the "Top-level object must be a mapping" error
Removed README Dependency in pyproject.toml
Removed the readme = "README_MCP.md" line from fast-markdown-mcp/pyproject.toml
This prevents the Python build system from looking for this file during installation
Fixes the error: "OSError: Readme file does not exist: README_MCP.md"
The MCP server will now build correctly in the Docker container
Added Documentation in README.md
Added a note in the Windows section of README.md explaining the automatic fix
Provides context for users who might encounter similar issues
These changes make the DevDocs project more robust on Windows systems by:
Automatically handling platform-specific file format issues
Removing unnecessary dependencies that were causing build failures
Providing clear documentation about the fixes
Copy file name to clipboardExpand all lines: README.md
+14-3Lines changed: 14 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -95,7 +95,7 @@ DevDocs is designed to be easy to use with Docker, requiring minimal setup for n
95
95
96
96
### Prerequisites
97
97
98
-
-[Docker](https://docs.docker.com/get-docker/)and [Docker Compose](https://docs.docker.com/compose/install/)installed on your system
98
+
-[Docker](https://docs.docker.com/get-docker/) installed on your system
99
99
- Git for cloning the repository
100
100
101
101
### Quick Start with Docker (Recommended)
@@ -123,8 +123,10 @@ cd DevDocs
123
123
# Start all services using Docker
124
124
docker-start.bat
125
125
```
126
+
<details>
127
+
<summary>Note for Windows Users</summary>
126
128
127
-
> **Note for Windows Users**: If you encounter permission issues, you may need to run the script as administrator or manually set permissions on the logs, storage, and crawl_results directories. The script uses the `icacls` command to set permissions, which might require elevated privileges on some Windows systems.
129
+
> If you encounter permission issues, you may need to run the script as administrator or manually set permissions on the logs, storage, and crawl_results directories. The script uses the `icacls` command to set permissions, which might require elevated privileges on some Windows systems.
128
130
>
129
131
> **Manually Setting Permissions on Windows**:
130
132
>
@@ -148,6 +150,15 @@ docker-start.bat
148
150
> icacls storage /grant Everyone:F /T
149
151
> icacls crawl_results /grant Everyone:F /T
150
152
> ```
153
+
</details>
154
+
155
+
<details>
156
+
<summary>Note about docker-compose.yml on Windows</summary>
157
+
158
+
> If you encounter issues with the docker-compose.yml file (such as "Top-level object must be a mapping" error), the `docker-start.bat` script automatically fixes this by ensuring the file has the correct format and encoding. This fix is applied every time you run the script, so you don't need to manually modify the file.
159
+
</details>
160
+
161
+
151
162
152
163
This single command will:
153
164
1. Create all necessary directories
@@ -290,4 +301,4 @@ Final Output Construction: The final answer should be organized, directly addres
290
301
291
302
<palign="center">
292
303
<sub>Make Software Development Better Again <ahref="https://github.com/cyberagi/devdocs">Contribute to DevDocs</a></sub>
0 commit comments