Skip to content

feat: align GitHub documentation with LocalSetup visual identity - #113

Merged
CruxExperts merged 9 commits into
mainfrom
feat/github-visual-identity
Sep 25, 2026
Merged

CruxExperts merged 9 commits into
mainfrom
feat/github-visual-identity

Conversation

@CruxExperts

Copy link
Copy Markdown
Owner

Summary

  • Apply the approved LocalSetup 1.0.0 visual contract to the README hero, architecture diagram, and installation flow in light and dark themes.
  • Keep existing light image paths and historical release art, add accessible theme-aware <picture> consumers, and teach the documentation inventory to count dark srcset images.
  • Pin and license JetBrains Mono v2.304 for reproducible graphics, document the AstroSite handoff, and prepare the 5.7.0 release guide and generated receipts.

Validation

  • Handoff ZIP manifests, font files, image exports, and embedded metadata verified.
  • Deterministic graphics render check, strict branding scan, documentation alignment CI, release-docs check, and publication preflight passed.
  • Focused branding, documentation, SDK, and worker-default tests: 53 passed.
  • Local full Python suite: 3,814 passed; 32 failed. One failure came from an inherited LOCALSETUP_TEST_WORKERS=3 override, six from the SDK receipt before it was refreshed (all 14 SDK tests now pass), and the remainder came from ignored broken local adapter symlinks copied into temporary test repositories. Clean GitHub CI is the final full-suite gate.

Compatibility

The localsetup framework command, lscli, and existing light image URLs remain unchanged. Nerd Font glyphs are documented as an optional future AstroSite profile; the shipped documentation graphics use the pinned official JetBrains Mono files.

@github-actions github-actions Bot added area/docs Affected repository area area/installer Installer, bootstrap, conversion, or rollback area/release Affected repository area status/needs-triage Triage status type/pr Issue or PR type labels Sep 25, 2026

@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: 10a787c5f6

ℹ️ About Codex in GitHub

Codex has been enabled to automatically 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 👍.

When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".

{
"schema_version": 1,
"version": "5.7.0",
"source_commit": "9a582770215b4322ac4e2b176ea5a2d4bb9012e4",

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P1 Badge Bind the release record to the candidate ancestry

9a582770... is on a different lineage from this commit (its merge base with 7e830ab is 51fbdf7, and it is not an ancestor). release-docs check explicitly rejects such records with source_not_ancestor, so this version-bump commit cannot pass the release documentation gate. Regenerate or rebind the record to a source commit in the final candidate's ancestry.

AGENTS.md reference: AGENTS.md:L45-L50

Useful? React with 👍 / 👎.

Comment on lines +132 to +136
def render(*, check: bool, social_output: Path | None) -> None:
for name, expected in FONT_HASHES.items():
actual = hashlib.sha256((BRAND / "fonts" / name).read_bytes()).hexdigest()
if actual != expected:
raise RuntimeError(f"Font hash mismatch: {name}")

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P1 Badge Move renderer implementation behind a thin tool wrapper

This new direct-execution tool contains the renderer's dependency validation, rendering, and write behavior in ls/tools/ rather than acting as the required thin entrypoint. Move the implementation into a dedicated ls/core package and leave this file to resolve the checkout and invoke its CLI, matching the repository's required Python-tooling architecture.

AGENTS.md reference: AGENTS.md:L70-L70

Useful? React with 👍 / 👎.

Comment on lines +153 to +157
os.environ["FONTCONFIG_FILE"] = str(config)
for weight, style in (("regular", "Regular"), ("demibold", "SemiBold")):
resolved = subprocess.run(
["fc-match", "-f", "%{family}|%{style}|%{file}", f"JetBrains Mono:weight={weight}"],
check=True, capture_output=True, text=True,

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 Remove the Linux-only fontconfig prerequisite

On a normal macOS checkout, fc-match and /etc/fonts/fonts.conf are not available, so the documented graphics renderer fails with FileNotFoundError before it can render or run --check; minimal Linux environments without Fontconfig fail similarly. Use a cross-platform bundled-font validation/rendering path, or provide and document a supported platform-specific renderer, so this repository tool remains portable.

AGENTS.md reference: AGENTS.md:L94-L94

Useful? React with 👍 / 👎.

@CruxExperts
CruxExperts merged commit 7dd25ad into main Sep 25, 2026
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/docs Affected repository area area/installer Installer, bootstrap, conversion, or rollback area/release Affected repository area status/needs-triage Triage status type/pr Issue or PR type

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant