Repository navigation
Docs/lui 151 readme adjustments - #101
Merged
Merged
Conversation
- Changed the instruction for creating the .env file to specify that the runner loads `.env.local` from the repository root, ensuring users understand the correct configuration for environment variables.
- Revised the description of Strive to emphasize its live status and added a note about trying the demo without signing up. - Clarified the prerequisites for setting up the database, including the need for Python packages. - Improved formatting and consistency in various sections for better readability.
- Introduced a new HTML file for the README banner, including detailed instructions for capturing screenshots in both light and dark themes. - Implemented CSS variables for theming and layout, ensuring consistency with existing wireframes. - Added JavaScript functionality for theme switching and embedded mode handling.
- Replaced existing wireframe images for both light and dark themes of Rhythm and The Arc with updated versions to enhance visual design consistency across the application.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
5 tasks done
This branch was successfully deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
README pass before the app goes live: fixes two bugs that made the quick start
impossible to follow, surfaces the docs that were missing from the index, and adds
a header so the repo reads as a product rather than a source tree.
Also fixes two real bugs in the wireframe capture pipeline, found while re-exporting
the landing screenshots.
Quick start was broken
Anyone following the README to the letter failed at step 3.
DATABASE_URLwas missing from the.env.localblock, althoughdata/migrate.pyreads it through
os.getenv('DATABASE_URL').needs Python 3 with
psycopg2-binaryandpython-dotenv.data/README.mdsaid to create a.envfile, while the runner loads.env.localfrom the repository root.
Header
design/wireframes/readme-banner.htmlis self-contained like the others, with the same OKLch tokens, the same Sora and
DM Sans,
?cleanand?theme=support, and a capture recipe in the file header.Exported at 2x to
public/readme-banner-{dark,light}.png, 1600x500, 20 KB each.stays real text under it. Text inside an image is invisible to GitHub search and
with images disabled.
# Strivesits under the banner. GitHub draws a border under README headings;placed there it separates the header from the content instead of cutting the
header in two.
documentation index. A technical reader asks what it is, whether they can see it,
and where the substance is. The deep dive was previously reachable only from
section 10.
<picture>withprefers-color-schemesoit follows the reader's GitHub theme, with the light variant as fallback.
Separated by non-breaking spaces: GitHub strips
styleattributes from READMEHTML and a table would draw cell borders.
README content
DEEP_DIVE.md,BUILD_LOG.mdandPITCH.mdadded to the documentationhighlights, before
ARCHITECTURE.md.credentials, and that is how most people have actually seen the app.
Wireframe capture pipeline
Two silent bugs in
rhythm.htmlandthe-arc.html:?theme=was ignored. The script read onlycleanand took the theme fromprefers-color-scheme, so exports followed the host OS and the right variant cameout by luck.
ai-chat-v2.htmlpins it to 420x720anchored top-left; these two did not, so with the ~490px minimum layout width a
headless browser applies, the centred frame was cropped from the left.
That is why they exported at 415x717 and 416x714 instead of 840x1440. Both files now
carry the pin, the theme parameter and a capture recipe, matching
ai-chat-v2.html.Captures also collapse the
done-sectiondetails, which the wireframe keeps open onpurpose for design review, so the export matches the in-app default and therefore the
screenshot already in production.
Landing screenshots re-exported at 2x
rhythmandthe-arcwere 1x and soft on retina. They are now 840x1440, exactly7/12, matching
ai-chat-v2. Composition unchanged, verified against the previousfiles before overwriting.
comment: it existed because the two images were 0.5788 and 0.5826 rather than 7/12.
<Image fill>withobject-containin a fixed-aspect container means no layout canbreak from the format change.
What to check on the preview: the screenshots section of the landing. The images
should fill their frame edge to edge, with no thin band at top and bottom.
If it does not look right:
git revert 7d8d2d3reverts only the four PNGs. TheREADME references the same paths either way, so nothing else is affected.
Verified
All referenced images and all 23 markdown links resolve. No em-dashes left.
Re-exported screenshots compared against the previous ones before overwriting.
Closes LUI-151.