Skip to content

Commit cb08c0e

Browse files
committed
fix: Remove the redundant "See Also" section from the document to simplify the content
1 parent 7b751a3 commit cb08c0e

File tree

11 files changed

+2
-78
lines changed

11 files changed

+2
-78
lines changed

content/docs/components/_index.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,4 +14,3 @@ Explore Sphere's building blocks and repositories.
1414
{{< card link="protoc-gen-sphere-binding" title="protoc-gen-sphere-binding" icon="document-duplicate" >}}
1515
{{< card link="protoc-gen-sphere-errors" title="protoc-gen-sphere-errors" icon="variable" >}}
1616
{{< /cards >}}
17-

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

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -394,8 +394,3 @@ service UserService {
394394
- Use with `protoc-gen-sphere` for HTTP routing
395395
- Combine with `protoc-gen-sphere-errors` for consistent error handling
396396
- Works with any transport layer that can use the generated interfaces
397-
398-
## See Also
399-
400-
- Concepts: ../../concepts/protocol-and-codegen
401-
- Component: ./protoc-gen-sphere

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

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -277,9 +277,3 @@ func inspectTags() {
277277
}
278278
}
279279
```
280-
281-
## See Also
282-
283-
- Guides: ../../guides/api-definitions
284-
- Component: ./protoc-gen-sphere
285-
- Concepts: ../../concepts/protocol-and-codegen

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

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -199,8 +199,3 @@ When used with Sphere's HTTP server utilities, these errors are automatically co
199199
- Sphere's Gin layer maps these to structured JSON with correct HTTP status
200200
- Pair with a global error parser if you need to merge validation/notfound/custom errors
201201
- The generated errors integrate seamlessly with Sphere's server utilities for consistent API responses
202-
203-
## See Also
204-
205-
- Guides: ../../guides/error-handling
206-
- Concepts: ../../concepts/protocol-and-codegen

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

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -45,10 +45,3 @@ plugins:
4545
Notes
4646
- Works hand-in-hand with Sphere’s Gin helpers: `WithJson`, `ShouldBindJSON`, `ShouldBindUri`, `ShouldBindQuery`
4747
- Pair with `protoc-gen-sphere-binding` to inject binding tags into generated structs
48-
49-
## See Also
50-
51-
- Guides: ../../guides/api-definitions
52-
- Component: ./protoc-gen-sphere-binding
53-
- Component: ./protoc-gen-sphere-errors
54-
- Concepts: ../../concepts/protocol-and-codegen

content/docs/components/sphere-cli.md

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -173,10 +173,4 @@ If generated code seems out of sync:
173173
```shell
174174
make clean # Clean generated files
175175
make gen/all # Regenerate everything
176-
```
177-
178-
## See Also
179-
180-
- [Quick Start](../../getting-started/quickstart) - Complete project setup guide
181-
- [Project Structure](../../concepts/project-structure) - Understanding the generated project layout
182-
- [Components Overview](../) - Details about protoc plugins used by sphere-cli
176+
```

content/docs/concepts/proto-packages.md

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -48,12 +48,3 @@ Purpose
4848
Use when
4949
- You build adapters beyond HTTP or need custom routing hints
5050

51-
See also
52-
- Component using options: ../components/protoc-gen-route
53-
54-
## See Also
55-
56-
- API Definitions Guide: ../guides/api-definitions
57-
- Error Handling Guide: ../guides/error-handling
58-
- Component: ../components/protoc-gen-route
59-

content/docs/concepts/protocol-and-codegen.md

Lines changed: 1 addition & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -34,18 +34,6 @@ Your `.proto` files serve as the authoritative definition of:
3434
- **HTTP mapping** (via annotations)
3535
- **Field constraints** (via validation rules)
3636

37-
### Service Definitions
38-
39-
Services declare operations and HTTP mappings via annotations. See ../guides/api-definitions for end‑to‑end examples.
40-
41-
### Message Definitions
42-
43-
Messages define the request/response contracts. Field binding is controlled with sphere/binding options; examples live in ../guides/api-definitions.
44-
45-
### Error Definitions
46-
47-
Define error enums with HTTP status/reason/message using sphere/errors. Usage and patterns are covered in ../guides/error-handling.
48-
4937
## Code Generation Pipeline
5038

5139
### Generator Chain
@@ -166,11 +154,4 @@ proto/
166154
1. **Comprehensive coverage**: Define errors for all failure modes
167155
2. **Appropriate status codes**: Use correct HTTP status codes
168156
3. **Clear messages**: Write user-friendly error messages
169-
4. **Structured data**: Include relevant context in errors
170-
171-
## See Also
172-
173-
- [API Definitions Guide](../guides/api-definitions) - Detailed HTTP mapping rules and examples
174-
- [Error Handling Guide](../guides/error-handling) - Comprehensive error patterns and implementation
175-
- [Components Overview](../components/) - Individual generator documentation and configuration
176-
- [Project Structure](project-structure) - How generated code fits into the overall project layout
157+
4. **Structured data**: Include relevant context in errors

content/docs/getting-started/quickstart.md

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -172,11 +172,3 @@ make gen/dts
172172
3. **Business Logic**: Implement service methods in `internal/service/**`
173173
4. **Wire and Run**: `make gen/wire``make run`
174174
5. **Client SDKs**: `make gen/dts` for TypeScript clients
175-
176-
## Next Steps
177-
178-
- [Project Structure](../concepts/project-structure) - Understand the directory layout
179-
- [API Definitions](../guides/api-definitions) - Learn HTTP mapping and binding rules
180-
- [Error Handling](../guides/error-handling) - Define typed, standardized errors
181-
- [Development Workflow](workflow) - Complete development process
182-

content/docs/getting-started/workflow.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,3 @@ make run
8383
- **Test early**: Use generated Swagger UI to verify endpoints
8484
- **Iterate fast**: Small changes → quick regeneration cycles
8585
- **Version APIs**: Use proto package versioning for breaking changes
86-
87-
See [Quick Start](quickstart) for the complete setup process.
88-

0 commit comments

Comments
 (0)