Skip to content

Docs finalization: full pipeline docs sync - #25

Merged
briancl2 merged 3 commits into
mainfrom
docs/finalization-worldfacing-2026-06-01
Jun 1, 2026
Merged

Docs finalization: full pipeline docs sync#25
briancl2 merged 3 commits into
mainfrom
docs/finalization-worldfacing-2026-06-01

Conversation

@briancl2

@briancl2 briancl2 commented Jun 1, 2026

Copy link
Copy Markdown
Owner

Summary

Finalization, sanitization, and documentation-sync pass for the world-facing repo.

Documentation

  • README.md / AGENTS.md: describe the full pipeline including optional phases 4.5 (polishing + deprecation consolidation), 4.6 (video matching), and 5 (editorial review). Removed broken April-bundle links and genericized April examples.
  • docs/ + mkdocs.yml: how-it-works.md and the architecture.md pipeline diagram now include phases 4.6/5 (MkDocs site is source-owned and propagated; mkdocs build --strict passes).

Sanitization

  • April removed (never an official newsletter release): output/2026-04_april_newsletter.md and release_bundle/2026-04_newsletter_launch/.
  • May release bundle: removed broken April-bundle/output links; fully templated the production command examples.
  • Security: sanitized 3 hardcoded local absolute paths (two referencing a separate private repo) in .github/prompts/research_system_report.prompt.md, and extended the publisher's sensitive-pattern scan with --hidden so the allowlisted-to-public .github/ tree is scanned (ripgrep skipped it by default, so the leak was previously undetected).

Newsletter content

  • Microsoft Build 2026 session guide in output/2026-05_may_newsletter.md: added the KEY01 opening keynote (Satya Nadella, Jun 2), swapped the BRK241 session for LIVE158 "New coding models optimized for GitHub Copilot" (Jun 3).

Tooling

  • Publisher gains a --world-facing flag + tools/public_snapshot_worldfacing_prune.txt that strips April for the world-facing repo only.

Validation

  • Public make test-all: all required suites pass.
  • Sensitive-pattern scan (now covering .github/): pass.
  • make validate-newsletter FILE=output/2026-05_may_newsletter.md: PASSED, 0 warnings.
  • No /Users/ local paths remain in tracked content.

…S Build refresh

- README/AGENTS: full pipeline phases (4.5/4.6/5), fix broken April links
- docs/+mkdocs: pipeline diagram + how-it-works phases 4.6/5
- remove April (never an official release) from world-facing:
  output/2026-04_april_newsletter.md + release_bundle/2026-04_newsletter_launch/
- May bundle: genericize April links, templated pinned command examples
- May newsletter: MS Build guide adds KEY01 opening keynote, swaps BRK241->LIVE158
- security: sanitize 3 local paths in .github research prompt; publisher now
  scans the hidden .github/ tree (--hidden) that was previously unscanned
- publisher: --world-facing flag + public_snapshot_worldfacing_prune.txt

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: a8ddd04b8e

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment on lines +9 to +10
release_bundle/2026-04_newsletter_launch/
output/2026-04_april_newsletter.md

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Stop allowlisting deleted April artifacts

These April paths are now deleted from the source repo, but they are still present in tools/public_snapshot_allowlist.txt, and the publisher only prunes them when --world-facing is passed. In the default publish path, a target repo that already has the April newsletter or launch bundle will just emit WARN missing path, skipped during sync and keep the stale public copies, so the “April never shipped” cleanup is incomplete unless every caller remembers the new flag. Move these paths to the common prune list or remove them from the default allowlist as part of the deletion.

Useful? React with 👍 / 👎.

briancl2 added 2 commits June 1, 2026 11:38
NEWSLETTER_SYSTEM_RELEASE_NOTES.md gains a 'Changes Since the February 2026
Release' section so it doubles as a standard release readout of every system +
repo change since the Feb 2026 release (system-at-a-glance, March-April, May,
June finalization, kb/source intel), cross-linked to the existing
cost-optimization subsections. April cycle described as world-facing-excluded
but retained in the GitHub-employee snapshot. Bundle README read-path updated.
Sanitize the world-facing repo of phrasing and files that exposed the
internal publishing tiers. Remove the publishing runbook and snapshot
machinery (publish_public_snapshot.sh, public_snapshot_*.txt,
public_repo_guide.md), drop the publish wrapper make target, and reword
docs to remove 'customer-safe', 'public catch-up', 'private source
repository', and the staging-vs-world-facing snapshot distinction.
@briancl2 briancl2 changed the title Docs finalization + sanitization: full pipeline docs, remove April, MS Build refresh Docs finalization: full pipeline docs sync Jun 1, 2026
@briancl2
briancl2 merged commit bc0a033 into main Jun 1, 2026
1 check passed
@briancl2
briancl2 deleted the docs/finalization-worldfacing-2026-06-01 branch June 1, 2026 17:19
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