Skip to content

Comments

Apply Neo4j Labs and Neo4j style guides#23

Merged
johnymontana merged 13 commits intomainfrom
styleguide
Jan 25, 2026
Merged

Apply Neo4j Labs and Neo4j style guides#23
johnymontana merged 13 commits intomainfrom
styleguide

Conversation

@johnymontana
Copy link
Collaborator

@johnymontana johnymontana commented Jan 25, 2026

This PR updates the documentation site and project branding to align with Neo4j Labs brand guidelines and integrates Chakra UI's design token system for a more polished, professional look.

Changes

Neo4j Labs Branding

  • Added Labs Purple (#6366F1) as primary accent color throughout docs
  • Added Neo4j Labs banner to all documentation pages
  • Added status badges (Experimental, Community Supported)
  • Added Labs disclaimers to example READMEs
  • Updated favicon with new brain+graph logo design
  • Created new logo.svg asset

Chakra UI Design Token Integration

  • Implemented full color scales (50-950) for Labs Purple and Neo4j Teal
  • Added semantic color tokens (--bg, --bg-subtle, --fg, --fg-muted, --border)
  • Expanded spacing scale with Chakra UI values (0.5, 1.5, 2.5, 3.5, 7, 9, 14, 16, 20, 24)
  • Added Neo4j brand typography (Syne for headings, Public Sans for body) via Google Fonts
  • Expanded border-radius scale (base, xl, 2xl, 3xl, full)
  • Added Chakra-style layered shadows (--shadow-xs through --shadow-2xl)
  • Added transition duration and easing tokens
  • Updated button styles with Chakra-inspired variants (solid, outline, subtle, ghost)
  • Improved card components with better shadows and hover effects
  • Updated dark theme with all semantic tokens

URL Fixes

  • Fixed incorrect GitHub URLs from neo4j-labs/neo4j-agent-memory to neo4j-labs/agent-memory
  • Updated library references to @neo4j-labs/agent-memory
  • Fixed example paths in documentation
  • Fixed Vercel deploy button URL in deployment docs
  • Updated documentation URL in pyproject.toml

Documentation Improvements

  • Added live demo link for Lenny's Memory Explorer (https://lennys-memory.vercel.app)
  • Removed duplicate DEPLOYMENT.md (content exists in reference/deployment.adoc)
  • Fixed search functionality by including Pagefind in default build script

Files Changed (17 files)

File Changes
docs/assets/style.css +600 lines - Complete CSS token overhaul
docs/build.js Added Google Fonts
docs/package.json Fixed build scripts to include search indexing
docs/index.adoc Added live demo link, fixed URLs
docs/DEPLOYMENT.md Deleted (duplicate)
docs/reference/deployment.adoc Fixed Vercel deploy button URL
docs/assets/favicon.svg New brain+graph logo
docs/assets/logo.svg New logo asset
README.md Added live demo link
pyproject.toml Fixed all project URLs
examples/lennys-memory/README.md Added live demo link, Labs disclaimer
examples/lennys-memory/frontend/.../Sidebar.tsx Fixed library URL and display name
examples/domain-schemas/README.md Added Labs disclaimer
examples/full-stack-chat-agent/README.md Added Labs disclaimer
docs/faq.adoc, docs/tutorials/index.adoc, docs/product-improvements.adoc Fixed URLs

Testing

  • Documentation builds successfully (npm run build)
  • Search functionality works (Pagefind indexed 43 pages, 6382 words)
  • Light and dark modes display correctly
  • All internal links validated
  • Live demo link verified (https://lennys-memory.vercel.app)

The documentation now features:

  • Neo4j Labs status banner at the top of every page
  • Refined typography with Syne headings and Public Sans body text
  • Improved button hover states with smooth transitions
  • Cards with subtle shadows and elevation on hover
  • Labs Purple accent color throughout

@vercel
Copy link

vercel bot commented Jan 25, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Review Updated (UTC)
agent-memory Ready Ready Preview, Comment Jan 25, 2026 0:25am

@johnymontana johnymontana marked this pull request as draft January 25, 2026 11:28
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Aligns project documentation and example READMEs with Neo4j Labs / Neo4j branding guidance by adding Labs status messaging and updating the docs site styling.

Changes:

  • Added Neo4j Labs support/disclaimer callouts to example READMEs and the root README (plus a new Support section).
  • Updated docs landing page and template to surface Labs status (hero eyebrow/badges + persistent Labs banner) and to use Neo4j brand typography.
  • Refreshed docs theme tokens and updated favicon artwork; added a standalone logo.svg asset.

Reviewed changes

Copilot reviewed 7 out of 9 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
examples/lennys-memory/README.md Adds Neo4j Labs disclaimer + support direction.
examples/full-stack-chat-agent/README.md Adds Neo4j Labs disclaimer + support direction.
examples/domain-schemas/README.md Adds Neo4j Labs disclaimer + support direction.
docs/index.adoc Adds Neo4j Labs labeling and status badges to the docs hero section.
docs/build.js Injects Google Fonts and a fixed Labs status banner; switches nav icon to SVG image.
docs/assets/style.css Introduces Chakra-like design tokens + Neo4j Labs styling; adds banner/badge styles and layout offsets.
docs/assets/logo.svg Adds a new logo asset (currently unused in build/template).
docs/assets/favicon.svg Updates favicon to match the new brain/graph mark and gradient.
README.md Adds Neo4j Labs badges/disclaimer and a Support section with links.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 14 out of 16 changed files in this pull request and generated 8 comments.

Comments suppressed due to low confidence (1)

docs/build.js:536

  • These external links use target="_blank" without rel="noopener noreferrer", which enables reverse-tabnabbing. Add rel="noopener noreferrer" to these anchors (and other target="_blank" links generated by this template).
          <a href="https://github.com/neo4j-labs/agent-memory" target="_blank">
            <i class="fab fa-github"></i> GitHub
          </a>
          <a href="https://pypi.org/project/neo4j-agent-memory/" target="_blank">
            <i class="fab fa-python"></i> PyPI

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Copy link

Copilot AI commented Jan 25, 2026

@johnymontana I've opened a new pull request, #24, to work on those changes. Once the pull request is ready, I'll request review from you.

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Copy link

Copilot AI commented Jan 25, 2026

@johnymontana I've opened a new pull request, #25, to work on those changes. Once the pull request is ready, I'll request review from you.

Copy link

Copilot AI commented Jan 25, 2026

@johnymontana I've opened a new pull request, #26, to work on those changes. Once the pull request is ready, I'll request review from you.

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Copy link

Copilot AI commented Jan 25, 2026

@johnymontana I've opened a new pull request, #27, to work on those changes. Once the pull request is ready, I'll request review from you.

@johnymontana johnymontana merged commit 0b80fd0 into main Jan 25, 2026
16 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