[Privacy Gateway] onboarding guide #18646
Open
Hyperlint AI / Hyperlint Style Guide
required action
Dec 11, 2024 in 20s
❌ Style guide issues found.
2 files reviewed, 9 total issue(s) found.
Details
📄 src/content/docs/privacy-gateway/privacy-proxy-onboarding.mdx
| Line | Issues | Text | Comment |
|---|---|---|---|
| 23 | (cloudflare.NonStandardQuotes-warning) Use standard single quotes or double quotes only. Do not use any of the following quote mark types: ‘ ’ “ ”. In the text, we found this character: ’ | Existing:- **Privacy Proxy**: The HTTP CONNECT-based proxy service running on Cloudflare’s edge. This service validates the PAT passed by the client, enforces any double spend prevention necessary for the token. The service handles proxying of the wrapped HTTP request, as well as selection of the egress path and IP.Replacement: - **Privacy Proxy**: The HTTP CONNECT-based proxy service running on Cloudflare's edge. This service validates the PAT passed by the client, enforces any double spend prevention necessary for the token. The service handles proxying of the wrapped HTTP request, as well as selection of the egress path and IP. | The non-standard single quote ’ in "Cloudflare’s" should be replaced with the standard single quote ' to comply with the style guide. |
| 26 | (cloudflare.NonStandardQuotes-warning) Use standard single quotes or double quotes only. Do not use any of the following quote mark types: ‘ ’ “ ”. In the text, we found this character: ’ | Existing:DNS resolution uses [Cloudflare’s public resolver (1.1.1.1)](/1.1.1.1/) infrastructure for name resolution.Replacement: DNS resolution uses [Cloudflare's public resolver (1.1.1.1)](/1.1.1.1/) infrastructure for name resolution. | The text contains a non-standard curly apostrophe (’). According to the style guide, we should use standard single quotes ('). The replacement text corrects this issue by using the standard single quote. |
| 113 |
| Existing:- A “code” field with the HTTP status code returned (matching the HTTP response status code) Replacement: - A "code" field with the HTTP status code returned (matching the HTTP response status code) | The text uses curly quotes around the word 'code', which violates the style guide's requirement to use standard straight quotes. The correction involves replacing the curly quotes with standard double quotes. |
| 114 |
| Existing:- A static “reason” of “UNSUPPORTED_COUNTRY” Replacement: - A static "reason" of "UNSUPPORTED_COUNTRY" | The text uses curly quotes which are non-standard according to the style guide. Replacing them with standard straight quotes resolves the issue. |
| 131 |
| Existing:Clients who attempt to mask their true location by “stacking” proxies/VPNs are not actively prevented from using the service. The Privacy Proxy assumes the client IP is the real IP of the client.Replacement: Clients who attempt to mask their true location by "stacking" proxies/VPNs are not actively prevented from using the service. The Privacy Proxy assumes the client IP is the real IP of the client. | The text uses curly quotes which are non-standard according to the style guide. Replacing them with standard straight quotes resolves the issue. |
| 147 | (cloudflare.NonStandardQuotes-warning) Use standard single quotes or double quotes only. Do not use any of the following quote mark types: ‘ ’ “ ”. In the text, we found this character: ’ | Existing:- In the former case, Cloudflare’s DNS Resolver service will be queried to map the name to an IP address.Replacement: - In the former case, Cloudflare's DNS Resolver service will be queried to map the name to an IP address. | The non-standard single quote (’) should be replaced with a standard single quote (') to adhere to the style guide. |
| 154 |
| Existing:Clients are required to authenticate themselves to use a Privacy Proxy tunnel for establishing upstream origin requests. This is done with a privacy authentication token (PAT). PATs are conveyed from client to proxy with the “ Proxy-Authorization ” header with an authentication scheme corresponding to the type of PAT.Replacement: Clients are required to authenticate themselves to use a Privacy Proxy tunnel for establishing upstream origin requests. This is done with a privacy authentication token (PAT). PATs are conveyed from client to proxy with the "Proxy-Authorization" header with an authentication scheme corresponding to the type of PAT. | Replaced curly quotes with standard straight quotes to adhere to the style guide's requirement for using standard single or double quotes. |
| 242 |
| Existing:- The “ _auto ” region indicates that the Privacy Proxy should use the (client; leftmost) IP address in the X-Forwarded-For HTTP request header shall be used for region selection by the edge service.Replacement: - The "_auto" region indicates that the Privacy Proxy should use the (client; leftmost) IP address in the X-Forwarded-For HTTP request header shall be used for region selection by the edge service. | The text uses curly quotes which are non-standard according to the style guide. Replacing them with standard straight quotes resolves the issue. |
| 250 |
| Existing:- This request may specify the desired quota management policy in an HTTP header, “Sec-Quota-Policy”, which is an integer value of either 1, 2, or 3 for single-use unlimited bandwidth, single-use limited bandwidth, and multi-use limited bandwidth, respectively.Replacement: - This request may specify the desired quota management policy in an HTTP header, "Sec-Quota-Policy", which is an integer value of either 1, 2, or 3 for single-use unlimited bandwidth, single-use limited bandwidth, and multi-use limited bandwidth, respectively. | Replaced curly quotes with standard straight quotes to comply with the style guide's requirement for using standard single or double quotes. |
🪄 About Hyperlint
Hyperlint is your AI-powered copilot for creating high-quality documentation with minimal effort.
Sign up for a free plan at hyperlint.com.
Loading