fix (docs): Deal with impact of Proto MD gen in docs

enola-dev · Dec 29, 2024 · 7440d3c · 7440d3c
1 parent 244a429
commit 7440d3c
Show file tree

Hide file tree

Showing 6 changed files with 4 additions and 12 deletions.
diff --git a/docs/concepts/core-arch.md b/docs/concepts/core-arch.md
@@ -18,7 +18,7 @@
 
 # Core Architecture
 
-These _logical models_ are [implemented](implementation.md) and further documented in [Protobuf messages](../dev/proto/core.md).
+These _logical models_ were originally [implemented](implementation.md) as Protobuf messages, but this is changing.
 
 <!-- TODO They are also published as JSON Schemas, for [`EntityKind`](../models/enola/schemas/EntityKind.schema.json)
 and [`Type`](../models/enola/schemas/Type.schema.json) et al. -->
diff --git a/docs/concepts/uri.md b/docs/concepts/uri.md
@@ -42,9 +42,7 @@ planned for the future.
 ## Available
 
 An Enola URI was originally defined as an `enola:{ns}.{entity}/path1/path2/...` ID; for example:
-`enola:demo.foo/abc/def`. The namespace (NS) and entity define the "kind" (type)
-of the entity and the paths an instance of it. This is further defined in
-[the Proto API doc](../dev/proto/core.md).
+`enola:demo.foo/abc/def`.
 
 This original `{ns}.{entity}/paths...` syntax has meanwhile been loosened to permit any unique string.
 

diff --git a/docs/dev/implementation.md b/docs/dev/implementation.md
@@ -78,7 +78,7 @@ _Builder._
 
 #### Proto Thing
 
-* Defined in: [`common/thing/thing.proto`](//java/dev/enola/thing/thing.proto), see [Proto doc](proto/thing.md#thing)
+* Defined in: [`common/thing/thing.proto`](//java/dev/enola/thing/thing.proto)
 * Java Type: `dev.enola.thing.proto.Thing` <!-- TODO https://github.com/enola-dev/enola/issues/491: Link to Java Doc -->
 
 #### Proto Message

diff --git a/docs/use/server/index.md b/docs/use/server/index.md
@@ -39,7 +39,7 @@ so e.g. on <http://[::]:8080/api/https://example.org/greeting2>.
 
 ## gRPC
 
-The `--grpcPort` flag starts [the Enola gRPC API](../../dev/proto/core.md#enolaservice).
+The `--grpcPort` flag starts the Enola gRPC API.
 
 This can be used by the Enola CLI Client's `--server` flag, instead of passing a `--load` file, like so:
 

diff --git a/mkdocs.yaml b/mkdocs.yaml
@@ -94,9 +94,6 @@ nav:
       - IDE: dev/ide.md
       - Architecture: concepts/implementation.md
       - Code Conventions: dev/style.md
-      - Protocol Buffer API:
-          - Thing Proto: dev/proto/thing.md
-          - Core Proto: dev/proto/core.md
       - Implementation Details: dev/implementation.md
       - Bazel: dev/bazel.md
       - Dependencies: dev/dependencies.md

diff --git a/tools/docs/build.bash b/tools/docs/build.bash
@@ -47,9 +47,6 @@ rm -f docs/BUILT/third_party/{BUILD*,*.bash}
 find docs/ -type f -name "*.md" -print0 \
   | xargs -n 1 -0 sed -i 's|(//|(https://github.com/enola-dev/enola/blob/main/|g'
 
-cp bazel-bin/java/dev/enola/thing/thing_proto_doc/thing_proto_doc.md docs/dev/proto/thing.md
-cp bazel-bin/java/dev/enola/core/core_proto_doc/core_proto_doc.md docs/dev/proto/core.md
-
 # Keep 'docs/use/**/*.md' in sync with tools/demo/test.bash & below
 ./enola execmd -vvvi "docs/use/**/*.md"
-Original file line number
+Diff line change
@@ Expand Up @@
     ## gRPC
-    The `--grpcPort` flag starts [the Enola gRPC API](../../dev/proto/core.md#enolaservice).
+    The `--grpcPort` flag starts the Enola gRPC API.
     This can be used by the Enola CLI Client's `--server` flag, instead of passing a `--load` file, like so:
@@ Expand Down @@