Skip to content

Remove references to local machine paths from public docs #26

@deanleigh

Description

@deanleigh

Public docs currently contain references to paths on the maintainer's local machine (e.g. `d:\Users\deanl\source\repos\Umbraco Extensions\Umbraco-CMS`). These leak into the published site and are useless to any other reader.

Example found: https://umtemplates.github.io/UpDoc/tooling/umbraco-skills/ — "Critical Lesson: Skills Are Supplementary" section references the local clone path.

Two parts to this issue:

Part 1 — Clean up existing references

Audit the entire `docs/` tree for:

  • Absolute Windows paths (`D:\, \C:\, \d:\users\`, etc.)
  • References to `deanl` or other personal usernames
  • Machine-specific URLs (localhost with specific ports unless documented as dev-only)
  • Any other path that only makes sense on the maintainer's machine

Replace with either:

  • Generic placeholder (``)
  • Explanatory prose ("a local clone of the Umbraco CMS source")
  • Nothing, if the path was only there as a personal aide-mémoire

Part 2 — Prevent future occurrences

Add guardrails so this doesn't happen again:

Option A: Astro build check — small script that scans built HTML for absolute local paths and fails the build if found. Could live in `docs/` as an npm script, called from the GitHub Action before deploy.

Option B: CLAUDE.md instruction — add a rule to the project's `CLAUDE.md` explicitly forbidding local-machine paths in public docs. Relies on Claude/human vigilance rather than automation.

Option C: Both — belt and braces. CLAUDE.md catches most cases up front, build check is the safety net.

My recommendation: Option C. The CLAUDE.md rule is free; the build check is maybe 20 lines of JS.

Scope notes

  • Planning docs (`planning/*.md`) and README-style files may contain local paths legitimately — they're developer-facing, not user-facing. Decision needed: do we clean them too, or only user-facing `docs/src/content/docs/`?
  • `CLAUDE.md` itself deliberately references `d:\Users\deanl...Umbraco-CMS` as setup context — keep as-is, it's telling future-Claude where to find the reference code on this specific machine.

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't workingdocumentationImprovements or additions to documentation

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions