Skip to content

chore: drop private repo details before launch - #57

Merged
susan-pgedge merged 2 commits into
mainfrom
chore/scrub-private-refs
Sep 29, 2026
Merged

susan-pgedge merged 2 commits into
mainfrom
chore/scrub-private-refs

Conversation

@AntTheLimey

@AntTheLimey AntTheLimey commented Sep 27, 2026 •

Copy link
Copy Markdown
Member

What changed

This repo goes public at launch, so this PR removes the console's
private repository from every checked-in file. The facts a
contributor needs about the console build stay.

  • README.md: removed the private repository's name (partly
    replaced earlier as "another repo"), its script and file paths, its
    test file names and the hosting provider.
  • Repo files: CLAUDE.md, CONTRIBUTING.md, requirements.txt,
    .coderabbit.yaml, the PR template, .github/console-links.txt,
    check-console-links.sh and build-docs.yml now say "the console"
    instead.
  • CLAUDE.md: also points Claude sessions at a note kept outside
    the repo that holds the exact paths, and says never to name a
    private repository here.
  • docs/managed/api/managed_reference.md: a CSS comment named the
    repository, and it ships in the built page's HTML source.

Gates

  • mkdocs build --strict: pass. The built site no longer contains the
    repository name.
  • check-console-links.sh: pass. bash -n on the edited script:
    pass.
  • pre-commit on all changed files, including yamllint: pass.
  • docs-writer check-mechanics.py --baseline main on the README and
    CONTRIBUTING.md: pass.
  • git grep for the private repository names, its file names and the
    hosting provider outside docs/: no matches.

Risks

  • Requirements comment: requirements.txt changes only in its
    comment header. The pins still match the console's.
  • History and past PRs: git history and past pull request
    descriptions still name private repositories. They are handled
    separately.

The README named a private repository's scripts, file paths and test
files, and its hosting provider. It now describes what a contributor
needs to know about the console build without them. A CSS comment on
the API reference page, which ships in the page source, named the same
repository.
CLAUDE.md, CONTRIBUTING.md, requirements.txt, the CodeRabbit config,
the PR template, the console-links list, its check script and the
build workflow named the console's private repository, its file paths
or its hosting. They now say "the console". CLAUDE.md also points
Claude sessions at a note kept outside the repo for the exact paths,
and says never to name a private repository here.
@susan-pgedge
susan-pgedge merged commit e11a4c4 into main Sep 29, 2026
3 checks passed
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.

2 participants