Skip to content

Use the reserved example.com domain in examples and tests - #15

Merged
dpleshakov merged 2 commits into
mainfrom
docs/example-domain
Oct 7, 2026
Merged

dpleshakov merged 2 commits into
mainfrom
docs/example-domain

Conversation

@dpleshakov

Copy link
Copy Markdown
Owner

Problem

Example URLs throughout the repository used company.com, a registered domain that belongs to a real company. The domain appeared in documentation, in test data, and in strings compiled into the binary: the server URL prompt of tfscli auth login and the example in the error for a URL that contains credentials.

Approach

RFC 2606 reserves example.com for documentation and examples, so tfs.company.com becomes tfs.example.com and shop.company.com becomes shop.example.com. Ports, paths, and the overall URL shape stay the same, because they illustrate the typical on-premises TFS address. The reserved .example top-level domain was considered and rejected: tfs.example.com reads as a realistic corporate address, which makes it the clearer example.

Notes

  • The change is a mechanical string replacement. Behavior is unchanged; tests compare the strings and make no network requests to these hosts.
  • The user-visible difference is limited to the example URL in the login prompt and in one error message, so there is no CHANGELOG.md entry.
  • The second commit edits docs/archive/2026-10-01-tasks-login-api-version.md. Archived tasks files are normally kept unedited as a record of the work. This edit is a deliberate exception: it replaces only the third-party domain and leaves the plan's content and decisions intact. It is a separate commit so that the exception stays visible in the history.

Testing

make check passes after the first commit. The second commit changes one line in an archived Markdown file that the build and tests do not read. rg 'company\.com' finds no matches in the repository.

dpleshakov and others added 2 commits October 7, 2026 07:48
company.com is a registered domain that belongs to a real company.
RFC 2606 reserves example.com for documentation, so the login prompt,
the error hint, the documentation, and the test data now use
tfs.example.com. The archived tasks file keeps its original text.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Te5mNQhPPc8k9Bm7GpKPx7
Archived tasks files are kept as a record of the work and are not
normally edited. This change is a deliberate exception: it does not
alter what the plan said or decided, it only replaces a third-party
domain used as an example URL with the reserved example.com
(RFC 2606), as the previous commit did everywhere else. With it, the
repository no longer refers to company.com anywhere.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Te5mNQhPPc8k9Bm7GpKPx7
@dpleshakov
dpleshakov merged commit d8f333a into main Oct 7, 2026
1 check passed
@dpleshakov
dpleshakov deleted the docs/example-domain branch October 7, 2026 05:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant