Skip to content

docs(readme): replace header with "Phase platform" diagram - #1021

Merged
rohan-chaturvedi merged 5 commits into
mainfrom
readme-update-26
Sep 16, 2026
Merged

rohan-chaturvedi merged 5 commits into
mainfrom
readme-update-26

Conversation

@nimish-ks

@nimish-ks nimish-ks commented Sep 12, 2026

Copy link
Copy Markdown
Member

Replaces the README header (logo, repo links, tagline, demo video, features table, CLI help dump) and the getting-started, self-hosting and SDK sections with a single theme-aware Phase platform diagram, a static SVG port of the docs landing-page "at a glance" sheet, linked to docs.phase.dev. The Community vs Enterprise, Security and Contributing sections stay as they were.

img/phase-platform-light.svg and img/phase-platform-dark.svg are picked by <picture> + prefers-color-scheme. Fonts and brand marks are embedded, so GitHub draws them identically on every platform. GitHub Mobile's native image renderer can't draw the SVGs, so img/phase-platform-{light,dark}.png (2× rasters of the same files) serve viewports up to 640px wide and act as the plain <img> fallback. All four are generated by a local skill rather than checked-in tooling, so the repo only carries the images.

Light

Phase platform diagram, light

Dark

Phase platform diagram, dark

@nimish-ks nimish-ks self-assigned this Sep 12, 2026
…ssentials

The README opened with a logo, repo links, a tagline, a demo MP4, a
features table, a CLI help dump, getting-started, self-hosting and SDK
sections that had drifted from the product and duplicate the docs.
Replace the lot with a single theme-aware diagram, a static SVG port of
the docs landing-page "Phase at a glance" sheet linked to docs.phase.dev,
and keep only the Community vs Enterprise, Security and Contributing
sections.

img/phase-platform-{light,dark}.svg are fixed-theme renders selected via
<picture> + prefers-color-scheme. The mono face (JetBrains Mono latin
subset, SIL OFL 1.1) and every brand mark are embedded so GitHub draws
the sheet identically on every platform. They are generated by a local
skill (phase-platform-diagram); regenerate rather than hand-edit.
@nimish-ks nimish-ks changed the title docs(readme): replace header with "Phase at a glance" diagram docs(readme): replace header with "Phase platform" diagram Sep 12, 2026
@nimish-ks
nimish-ks marked this pull request as ready for review September 12, 2026 13:36
GitHub Mobile renders README images with a native rasteriser that fails
on the platform SVGs (embedded font, <symbol>/<use>), so the diagram was
blank in the Android app. Add img/phase-platform-{light,dark}.png, 2×
rasters of the same SVGs, and order the <picture> sources so phones and
the app get a raster while desktop browsers keep the SVG:

  1. PNG sources for (max-width: 640px), dark and light
  2. SVG sources for prefers-color-scheme with type="image/svg+xml"
  3. the light PNG as the plain <img> fallback

Generated by the same local skill as the SVGs.
@rohan-chaturvedi
rohan-chaturvedi merged commit aa0fb5c into main Sep 16, 2026
15 checks passed
@nimish-ks
nimish-ks deleted the readme-update-26 branch September 16, 2026 15:13
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