Skip to content

Conversation

@Sunflower-dak
Copy link

Pull Request Summary: Plutonium Documentation & UI Revamp

Overview

This pull request delivers a comprehensive improvement to the Plutonium documentation site built with VitePress.
It focuses on modernizing the landing page copy, improving the folder structure, refining the navigation experience, and enhancing content accessibility for both technical and visual learners.

Key Improvements

  1. Content and Copy Enhancements
  • Rewrote the homepage copy to make Plutonium’s value proposition clearer and more compelling.
  • New tagline: “Build enterprise apps at startup speed. Imagine Rails; but faster, smarter, and easier to ship.”
  • Unified tone across all sections to emphasize developer productivity, speed, and scalability.
  • Improved the connection between problem (repetitive Rails setup) and solution (Plutonium’s generators).
  • Added metrics-driven storytelling: “88% Less Code | 79% Faster MVP.”
  • Revised CTA links for better clarity and user flow:
  • “Read the Docs” now links directly to /documentation/installation/01-installation.
  • Added a persistent “Full Installation Guide” button for quick access.
  1. Structural and Organizational Refactor
  • Renamed and reorganized the folder structure for better clarity and maintainability:
    guide → documentation
    guide/deep-dive → documentation/advanced-concept
    guide/getting-started → documentation/installation
    guide/introduction → documentation/fundamental-idea
  • Added a Contribute section for community and developer engagement.
  • Introduced a Visual Tutorial route linking to the official YouTube walkthrough for Plutonium, catering to visual learners.
  • Streamlined file naming and directory hierarchy to align with documentation best practices.
  1. Navigation and Sidebar Improvements

Updated top navigation to use “Documentation” instead of “Docs.”

Reorganized sidebar structure for an intuitive learning progression:

  • Fundamentals
  • Documentation
    • Installation
    • Tutorial
    • Advanced Concepts
  • Modules
  • Help
  • Plutonium in 30 Minutes

Updated all internal links to reflect the new directory paths and file names.

  1. UI and Visual Enhancements
  • Refined landing page visuals with improved typography and gradient text styling.
  • Modified CSS for horizontal dropdown menus, replacing the default vertical stack for better space utilization.
  • Added a gradient highlight for key phrases like “Rails + Plutonium.”
  • Adjusted layout spacing and color balance for a cleaner, modern look.
  1. Footer Improvements

Updated footer configuration to dynamically display the current year for license and copyright.

footer: { message: "Released under the MIT License.", copyright: `Copyright © ${new Date().getFullYear()} - Radioactive Labs`, }, 

Prospective Result of this contribution:

  • Cleaner, faster, and more intuitive documentation experience.
  • Improved storytelling and positioning of Plutonium’s value proposition.
  • Streamlined folder structure for maintainability and scalability.
  • More accessible learning experience for both developers and visual learners.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

1 participant