docs: Comprehensive documentation restructure and README improvements#300
Merged
docs: Comprehensive documentation restructure and README improvements#300
Conversation
… usage - README: Add developer-focused content with build/test/dev setup - README: Add feature highlights and enhanced YAML examples - README: Document all CLI flags and session lifecycle features - docs: Update homepage with feature highlights (v0.15.0) - docs/basics: Add session export, stop flags, shell completions - docs/basics: Add comprehensive YAML field reference - docs/advanced: Add focus/zoom features, config management - docs/advanced: Add session export caveats about wrapper commands - docs/advanced: Add minimal Zellij experimental support mention
**New Structure:** - getting-started/ - Quick start and first session guides - configuration/ - YAML reference, layouts, lifecycle hooks - workflow/ - Managing configs, local configs, session export - reference/ - Complete CLI command reference **New Pages:** - getting-started/quick-start.md - Minimal getting started guide - getting-started/your-first-session.md - Create first config walkthrough - configuration/yaml-reference.md - Complete field documentation - configuration/layouts.md - Flexbox layouts, focus, zoom - configuration/lifecycle.md - Startup/shutdown hooks and scripts - workflow/managing-configs.md - Create, edit, validate, delete - workflow/local-configs.md - Project .laio.yaml workflow - workflow/session-export.md - Export sessions with caveats - reference/cli-commands.md - All commands with examples **Updated Pages:** - basics.md - Streamlined with links to detailed sections - advanced.md - Condensed with references to new pages Improves navigation, reduces page length, better content organization.
The content from basics.md and advanced.md is now properly distributed across focused pages: - Command reference -> reference/cli-commands.md - Config management -> workflow/managing-configs.md - Local configs -> workflow/local-configs.md - Session export -> workflow/session-export.md - YAML examples -> configuration/yaml-reference.md - Layouts -> configuration/layouts.md - Known limitations -> reference/cli-commands.md - Session switching -> reference/cli-commands.md getting-started/ now contains only: - installing.md - Installation instructions - quick-start.md - Minimal getting started - your-first-session.md - First config walkthrough This eliminates redundancy and creates a cleaner navigation structure.
Corrected the split terminology throughout documentation: - Vertical split = split line runs vertically = panes side-by-side (left/right) - Horizontal split = split line runs horizontally = panes stacked (top/bottom) In laio (following CSS Flexbox convention): - flex_direction: row → vertical split (side-by-side) - flex_direction: column → horizontal split (stacked) Previous docs incorrectly said "horizontal splits (panes side-by-side)" which was contradictory. Now consistently describes splits by the orientation of the split line itself. Also corrected default from 'column' to 'row' based on code.
Added nushell shell completion support with installation example. Nushell is supported via clap_complete_nushell dependency.
Changed nushell completion example to use proper nushell syntax with pipe and 'save' command instead of bash redirect.
Moved nushell completion back into the main bash code block with a comment noting it uses nushell syntax. Keeps examples together and easier to read.
Use $env.HOME and path join instead of tilde expansion for nushell completion example to follow nushell best practices.
Used sed to remove trailing whitespace from 5 documentation files without altering content.
- Implement fix-whitespace git hook for staged files - Integrate hook using gnused and shell script in pre-commit stage
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.
Overview
This PR comprehensively restructures the documentation and updates the README to improve discoverability, clarity, and user onboarding.
Documentation Changes
Restructured Documentation Organization
The documentation has been reorganized into four focused sections:
Getting Started - Streamlined onboarding experience
Configuration - Deep dive into configuration options
Workflow - Day-to-day usage patterns
Reference - Command-line interface documentation
Removed Content
Content Improvements
README Updates
Enhanced Feature List
Expanded from bullet points to descriptive features:
Improved Structure
Development Infrastructure
Pre-commit Hook
Added automated whitespace management to the development environment:
File:
nix/devenv/developer.nixAdded a pre-commit git hook that automatically:
sedThis ensures consistent formatting across all files going forward.
Impact
These changes significantly improve:
Testing