Skip to content

Conversation

@HeyItsGilbert
Copy link
Member

This commit reorganizes the documentation structure to better utilize the navbar and improve user experience:

Navbar Changes:

  • Split single "Tutorial" dropdown into three focused sections:
    • "Get Started" - Beginner onboarding (6 pages)
    • "Guides" - How-to guides and examples (21 pages)
    • "Reference" - Commands, troubleshooting, and lookup materials (20+ pages)

Sidebar Restructuring:

  • Created gettingStartedSidebar with essential quick-start content
  • Created guidesSidebar organized into:
    • Core Concepts
    • Advanced Techniques
    • Build Type Examples
    • CI/CD Integration
  • Created referenceSidebar with:
    • Command Reference (auto-generated)
    • Reference Materials
    • Troubleshooting
    • Code of Conduct

Content Updates:

  • Streamlined intro.md (Quick Start page) by replacing detailed documentation guide with focused "Next Steps" section
  • Updated footer links to reflect new structure
  • Improved information architecture for faster content discovery

Benefits:

  • Command reference now accessible in 2 clicks vs deep sidebar navigation
  • Clear separation between learning content and lookup content
  • Reduced cognitive load with focused, purposeful sections
  • Better SEO through improved content organization
  • No breaking changes - all URLs remain valid

This commit reorganizes the documentation structure to better utilize
the navbar and improve user experience:

**Navbar Changes:**
- Split single "Tutorial" dropdown into three focused sections:
  - "Get Started" - Beginner onboarding (6 pages)
  - "Guides" - How-to guides and examples (21 pages)
  - "Reference" - Commands, troubleshooting, and lookup materials (20+ pages)

**Sidebar Restructuring:**
- Created gettingStartedSidebar with essential quick-start content
- Created guidesSidebar organized into:
  - Core Concepts
  - Advanced Techniques
  - Build Type Examples
  - CI/CD Integration
- Created referenceSidebar with:
  - Command Reference (auto-generated)
  - Reference Materials
  - Troubleshooting
  - Code of Conduct

**Content Updates:**
- Streamlined intro.md (Quick Start page) by replacing detailed
  documentation guide with focused "Next Steps" section
- Updated footer links to reflect new structure
- Improved information architecture for faster content discovery

**Benefits:**
- Command reference now accessible in 2 clicks vs deep sidebar navigation
- Clear separation between learning content and lookup content
- Reduced cognitive load with focused, purposeful sections
- Better SEO through improved content organization
- No breaking changes - all URLs remain valid
@netlify
Copy link

netlify bot commented Dec 7, 2025

Deploy Preview for psake ready!

Name Link
🔨 Latest commit a57dc38
🔍 Latest deploy log https://app.netlify.com/projects/psake/deploys/6935fc53a32cbc00087882d2
😎 Deploy Preview https://deploy-preview-33--psake.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

Set --ifm-background-color to #F8F9F5 for a softer, more pleasant
background that reduces eye strain while maintaining readability.
…arameter

Updated the Getting Help page to provide comprehensive support resources:

- Added "View Available Tasks" section documenting Invoke-psake -Docs
  parameter for listing tasks in build scripts
- Reorganized content into clear sections: Built-in Help, Community
  Support, and Documentation
- Added Community Support section with links to:
  - PowerShell Discord #psake channel
  - PowerShell Slack #psake channel
  - GitHub Discussions
  - Stack Overflow psake tag
  - GitHub Issues for bug reports
- Improved PowerShell examples with cleaner output formatting
- Added cross-references to Command Reference, Troubleshooting, and FAQ
- Updated description frontmatter for better SEO
@HeyItsGilbert HeyItsGilbert merged commit 9cd67e9 into main Dec 7, 2025
8 checks passed
@HeyItsGilbert HeyItsGilbert deleted the claude/restructure-docs-navbar-012JH3fcyNHUZxgKc9usEg5M branch December 7, 2025 22:17
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.

3 participants