fork of https://github.com/sourcegraph/zoekt
Add README for proto directories (#943)
Somehow I just found out about `gen-proto.sh` recently, after many months of
working on Zoekt! This PR adds brief `README` files in the proto directories to
guide people (and LLMs) to it.
author
Julie Tibshirani
committer
GitHub
date
(Apr 15, 2025, 9:36 AM -0700)
commit
75879a72
75879a727dd21041fd8485106bf93e75be5ef028
parent
858516b9
858516b98ec252c033e9413b7351badfa8afe4e4
+22
+11
cmd/zoekt-sourcegraph-indexserver/grpc/protos/README.md
+11
cmd/zoekt-sourcegraph-indexserver/grpc/protos/README.md
···
1
+
# Sourcegraph indexserver protobuf definitions
2
+
3
+
This directory contains protobuf definitions for the indexserver gRPC API.
4
+
5
+
To generate the Go code, run this script from the repository root:
6
+
7
+
```sh
8
+
./gen-proto.sh
9
+
```
10
+
11
+
Note: this script will regenerate all protos in the project, not just the ones in this directory.
+11
grpc/protos/README.md
+11
grpc/protos/README.md
···
1
+
# Webserver protobuf definitions
2
+
3
+
This directory contains protobuf definitions for the webserver gRPC API.
4
+
5
+
To generate the Go code, run this script from the repository root:
6
+
7
+
```sh
8
+
./gen-proto.sh
9
+
```
10
+
11
+
Note: this script will regenerate all protos in the project, not just the ones in this directory.