[release] fix docs (#138)

Author: SockworkOrange

.github/workflows/docs.yml

@@ -34,7 +34,7 @@ jobs:
         run: |
           ./scripts/docs/generate_quickstart.sh 02_Quickstart.md
           ./scripts/docs/generate_examples.sh __Examples.md
-          cat docs/0*.md > README.md
+          cat docs/0*.md | grep -v "This section was auto-generated by" > README.md
 
       - name: Create Pull Request
         uses: peter-evans/create-pull-request@v6

Makefile

@@ -2,9 +2,7 @@ SHELL 		:= /bin/bash
 PWD 		:= $(shell pwd)
 
 dotnet-format:
-	dotnet format \
-		--exclude GeneratedProtobuf \
-		--exclude examples
+	dotnet format --exclude GeneratedProtobuf --exclude examples
 
 protobuf-generate:
 	#./scripts/generate_protobuf.sh

README.md

@@ -14,7 +14,6 @@ sqlc-gen-csharp is a .Net plugin for [sqlc](https://github.com/sqlc-dev/sqlc).<b
 | namespaceName          | default: the generated project name                                                                                                                                                | Yes      | Allows you to override the namespace name to be different than the project name                                                                                                                                                                                                                                                           |
 | useDapper              | default: `false`<br/>values: `false`,`true`                                                                                                                                        | Yes      | Enables Dapper as a thin wrapper for the generated code. For more information, please refer to the [Dapper documentation](https://github.com/DapperLib/Dapper). |
 | overrideDapperVersion  | default:<br/> `2.1.35`<br/>values: The desired Dapper version                                                                                                                      | Yes      | If `useDapper` is set to `true`, this option allows you to override the version of Dapper to be used. |
-[comment]: <> (do not edit - auto-generated by CI)
 # Quickstart
 ## Configuration
 ```yaml
@@ -51,7 +50,6 @@ sql:
 ## Examples
 All of the examples can be found in [here](/docs/__Examples.md).
 # Contributing
-
 ## Local plugin development
 ### Prerequisites
 Make sure that the following applications are installed and added to your path.

docs/02_Quickstart.md

@@ -1,5 +1,5 @@
-[comment]: <> (do not edit - auto-generated by CI)
 # Quickstart
+**This section was auto-generated by generate_quickstart.sh**
 ## Configuration
 ```yaml
 version: "2"

docs/03_Contributing.md

@@ -1,5 +1,4 @@
 # Contributing
-
 ## Local plugin development
 ### Prerequisites
 Make sure that the following applications are installed and added to your path.

docs/__Examples.md

@@ -1,5 +1,6 @@
-[comment]: <> (do not edit - auto-generated by CI)
 # Examples
+**This section was auto-generated by generate_examples.sh**
+
 ## Engine `postgresql`: [../NpgsqlExample](examples/NpgsqlExample)
 
 ### [Schema](../examples/config/postgresql/schema.sql) | [Queries](../examples/config/postgresql/query.sql) | [End2End Test](../EndToEndTests/NpgsqlTester.cs)

scripts/docs/generate_examples.sh

@@ -2,11 +2,13 @@
 
 set -e
 
+me=$(basename "$0")
 doc_file="docs/$1"
 
 examples_cnt=$(yq ".sql | length" sqlc.ci.yaml)
-contents="[comment]: <> (do not edit - auto-generated by CI)
-# Examples"
+contents="# Examples
+**This section was auto-generated by ${me}**
+"
 
 for ((i = 0 ; i < "${examples_cnt}" ; i++ )); do 
     engine_name=$(yq ".sql[${i}].engine" sqlc.ci.yaml)

scripts/docs/generate_quickstart.sh

@@ -2,13 +2,15 @@
 
 set -e
 
+me=$(basename "$0")
 doc_file="docs/$1"
+
 plugin_version=$(git tag | sort --version-sort | tail -n1)
 plugin_url="https://github.com/DaredevilOSS/sqlc-gen-csharp/releases/download/${plugin_version}/sqlc-gen-csharp.wasm"
 release_sha=$(curl -s "${plugin_url}" | shasum -a 256 | awk '{ print $1 }')
 
-contents="[comment]: <> (do not edit - auto-generated by CI)
-# Quickstart
+contents="# Quickstart
+**This section was auto-generated by ${me}**
 ## Configuration
 \`\`\`yaml
 version: \"2\"