Redaction still too strong

[dsyme]

We have very strong redaction of URLs, which is very noticeable

@pelikhan @lpcox We should discuss. Removing redaction of localhost URLs is easy, but we should also consider these others.

Examples where redactions are notably too strong

Example 1

Example 2 - localhost URLs redacted

🤖 *This is an automated response from Repo Assist.*

Looking at the source, I can confirm why `--parameters root "/"` doesn't work in watch mode: the code in [`BuildCommand.fs` around line 1423](https://github.com/fsprojects/FSharp.Formatting/blob/main/src/fsdocs-tool/BuildCommand.fs#L1421) **explicitly ignores** any user-specified `root` parameter when `watch = true` and forces it to `(localhost/redacted)

Example 3 - microsoft URLs redacted

fsprojects/FSharp.Formatting#1005

See the [NuGet trusted publishing docs]((learn.microsoft.com/redacted) for screenshots and more details.

Example 4 - Useful URLs redacted, e.g. highlightjs.org/redacted

fsprojects/FSharp.Formatting#468

This is the format expected by both [highlight.js]((highlightjs.org/redacted) and [prism.js]((prismjs.com/redacted) for syntax highlighting. So ```python in a Markdown file will render as <pre><code class="language-python">.

Example 5 - localhost URLs redacted

fsprojects/FSharp.Formatting#1089

fsdocs watch always forced root = (localhost/redacted) ignoring any --parameters rootthe user supplied. This makes generated pages broken when served in GitHub Codespaces (port-forwarding replaceslocalhost` with a cloud URL), behind a reverse proxy, or in any other non-localhost environment.

Example 6 - Useful standard URls redacted (mozilla, web.dev)

Adds [scrollbar-gutter: stable]((developer.mozilla.org/redacted) (part of the [2024 Baseline]((web.dev/redacted) to all vertical-scroll containers in fsdocs-default.css.

Example 7 - Useful standard URLs redacted (commonmark)

fsprojects/FSharp.Formatting#1028

This PR improves CommonMark compliance for ATX headings in the Markdown parser. The changes fix four specific deviations from the [CommonMark spec for ATX headings]((spec.commonmark.org/redacted)

[mvanhorn]

Agentic Implementation Plan: Relax URL Redaction

Problem

URL redaction is too aggressive - masking localhost URLs and known-safe URLs (GitHub, docs) makes output unreadable for debugging.

Proposed Changes

1. Add a URL whitelist to the redaction logic:

   • localhost, 127.0.0.1, ::1 (all ports)
   • github.com, docs.github.com
   • *.githubusercontent.com

2. Refine the redaction regex to only mask URLs that contain potentially sensitive query parameters (tokens, keys, secrets, passwords) rather than all URLs

3. Keep redaction for:

   • URLs with token=, key=, secret=, password=, api_key= in query params
   • URLs with basic auth (user:pass@host)
   • Non-whitelisted external URLs in sensitive contexts

Files to Investigate

• Search for redaction rules in the security/firewall module
• Look for URL pattern matching in output sanitization

Testing

• Verify localhost URLs appear unredacted in output
• Verify GitHub URLs appear unredacted
• Verify URLs with secrets in query params are still redacted
• Verify basic auth URLs are still redacted

Happy to elaborate on any part of this plan.

[pelikhan]

@dsyme create a default-safe-output set of domains and update allowed-domains to be union with network.allowed.

[pelikhan]

See https://github.com/github/gh-aw/releases/tag/v0.59.0