Skip to content

Commit ff69648

Browse files
committed
docs: Updated document weights to optimize content structure and navigation
1 parent 6452802 commit ff69648

18 files changed

+19
-16
lines changed

content/docs/components/cli/sphere-cli.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Sphere CLI
3-
weight: 10
3+
weight: 32
44
---
55

66
Sphere CLI (`sphere-cli`) is a command-line tool designed to streamline the development of [Sphere](https://github.com/go-sphere/sphere) projects. It helps you create new projects, generate service code, manage Protobuf definitions, and perform other common development tasks.

content/docs/components/core.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Core
3-
weight: 10
3+
weight: 33
44
---
55

66
Sphere Core repositories and what they provide.
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Generators
3-
weight: 20
3+
weight: 34
44
---
55

66
Protobuf-centric generators that produce handlers, bindings, routing glue, and typed errors.
@@ -9,8 +9,8 @@ Protobuf-centric generators that produce handlers, bindings, routing glue, and t
99

1010
{{< cards >}}
1111
{{< card link="protoc-gen-route" title="protoc-gen-route" icon="template" >}}
12-
{{< card link="protoc-gen-sphere" title="protoc-gen-sphere" icon="sparkles" >}}
1312
{{< card link="protoc-gen-sphere-binding" title="protoc-gen-sphere-binding" icon="document-duplicate" >}}
1413
{{< card link="protoc-gen-sphere-errors" title="protoc-gen-sphere-errors" icon="variable" >}}
14+
{{< card link="protoc-gen-sphere" title="protoc-gen-sphere" icon="sparkles" >}}
1515
{{< /cards >}}
1616

content/docs/components/generators/protoc-gen-route.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: protoc-gen-route
3-
weight: 20
3+
weight: 35
44
---
55

66
`protoc-gen-route` is a protoc plugin that generates routing code from `.proto` files. It is designed to inspect service definitions within your protobuf files and automatically generate corresponding route handlers based on a specified template. This plugin creates Go code that provides structured routing with operation constants, extra data handling, server interfaces, and codec interfaces for seamless integration with various transport protocols.

content/docs/components/generators/protoc-gen-sphere-binding.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: protoc-gen-sphere-binding
3-
weight: 30
3+
weight: 36
44
---
55

66
`protoc-gen-sphere-binding` is a protoc plugin that generates Go struct tags for Sphere binding from `.proto` files. It is designed to inspect service definitions within your protobuf files and automatically generate corresponding Go struct tags based on sphere binding annotations.

content/docs/components/generators/protoc-gen-sphere-errors.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: protoc-gen-sphere-errors
3-
weight: 40
3+
weight: 37
44
---
55

66
`protoc-gen-sphere-errors` is a protoc plugin that generates error handling code from `.proto` files. It is designed to inspect enum definitions within your protobuf files and automatically generate corresponding error handling code based on the sphere errors framework. This plugin creates Go code that provides structured error handling with HTTP status codes, error codes, and customizable messages.

content/docs/components/generators/protoc-gen-sphere.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: protoc-gen-sphere
3-
weight: 10
3+
weight: 38
44
---
55

66
Generates HTTP server code from `.proto` service definitions, using `google.api.http` annotations and Sphere server utilities (Gin-based).

content/docs/concepts/architecture-and-repo.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Architecture & Repository Strategy
3-
weight: 40
3+
weight: 25
44
aliases:
55
- /docs/concepts/microservice-architecture/
66
- /docs/concepts/code-repository-types/

content/docs/concepts/project-structure.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Project Structure
3-
weight: 10
3+
weight: 21
44
aliases:
55
- /docs/concepts/project-code-structure/
66
- /docs/concepts/project-layout/

content/docs/concepts/proto-packages.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Proto Packages
3-
weight: 30
3+
weight: 22
44
---
55

66
Sphere provides several core proto packages that extend Protobuf with specialized annotations for HTTP binding, error handling, and method options. These packages enable the code generation pipeline and provide the foundation for Sphere's contract-first approach.

0 commit comments

Comments
 (0)