Skip to content

Remove duplicated docs#86

Merged
Suhaibinator merged 1 commit intomainfrom
codex/consolidate-redundant-documentation
Jun 8, 2025
Merged

Remove duplicated docs#86
Suhaibinator merged 1 commit intomainfrom
codex/consolidate-redundant-documentation

Conversation

@Suhaibinator
Copy link
Copy Markdown
Owner

Summary

  • cut repeated middleware order info from performance docs
  • remove IP configuration duplication in security docs
  • streamline trace logging section in logging docs

Testing

  • go vet ./...
  • go test ./...

https://chatgpt.com/codex/tasks/task_e_6845f4ce1654833199443a9c916ffbee

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR removes duplicated documentation across security, performance, and logging guides to streamline the content, ensuring developers have a single, accurate source of information.

  • Removed detailed duplicate IP configuration info from the security docs
  • Simplified middleware ordering explanations in the performance docs
  • Streamlined trace logging information in the logging docs

Reviewed Changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.

File Description
docs/security.md Removed redundant content on IP configuration and replaced it with a concise summary and link
docs/performance.md Updated header and explanatory text to focus on middleware overhead rather than ordering
docs/logging.md Condensed trace ID logging example into a concise paragraph with a reference link
Comments suppressed due to low confidence (3)

docs/security.md:7

  • [nitpick] Removing duplicate configuration details is acceptable as long as the referenced document contains all necessary details; consider adding a brief note to direct advanced users to additional configuration specifics if needed.
Correctly extracting the client IP is crucial for logging, rate limiting, and other security features. SRouter provides extensive configuration via `IPConfig` to handle proxies and custom headers. See the dedicated [IP Configuration](./ip-configuration.md) documentation for details and security recommendations.

docs/performance.md:9

  • [nitpick] The simplification to 'Middleware Overhead' omits the specific ordering details; if this abstraction is intentional and covered elsewhere (e.g., in the linked Custom Middleware docs), it's acceptable. Otherwise, consider briefly summarizing the middleware execution order for added clarity.
## Middleware Overhead

docs/logging.md:69

  • [nitpick] The concise explanation is clear; ensure that any future changes to trace ID functionality are consistently reflected across both internal logging and the linked trace logging example.
When trace IDs are enabled via `TraceIDBufferSize`, SRouter automatically attaches a `trace_id` field to its logs. Include this ID in your own log entries for full request tracing. See [Trace ID Logging](./trace-logging.md) for example usage.

@codecov
Copy link
Copy Markdown

codecov bot commented Jun 8, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.16%. Comparing base (2fde7d5) to head (2b4dbe6).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #86   +/-   ##
=======================================
  Coverage   97.16%   97.16%           
=======================================
  Files          18       18           
  Lines        2363     2363           
=======================================
  Hits         2296     2296           
  Misses         55       55           
  Partials       12       12           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@Suhaibinator Suhaibinator merged commit 1cbdacb into main Jun 8, 2025
11 checks passed
@Suhaibinator Suhaibinator deleted the codex/consolidate-redundant-documentation branch June 8, 2025 20:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants