Skip to content

Commit f60fed5

Browse files
committed
Restructure documentation navbar for improved navigation
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
1 parent 51ad769 commit f60fed5

File tree

3 files changed

+55
-80
lines changed

3 files changed

+55
-80
lines changed

docs/intro.md

Lines changed: 7 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -101,46 +101,13 @@ to orchestrate their build process.
101101
* [ICU4N](https://github.com/NightOwl888/ICU4N)
102102
* [RandomizedTesting](https://github.com/NightOwl888/RandomizedTesting)
103103

104-
## Documentation Guide
104+
## Next Steps
105105

106-
### Getting Started
106+
Ready to start using psake? Here's what to do next:
107107

108-
New to psake? Start here:
108+
1. **[Install psake](/docs/tutorial-basics/installing)** - Get psake set up on your system
109+
2. **[Run your first build](/docs/tutorial-basics/run-psake)** - Create and execute your first psake script
110+
3. **[Explore the Guides](/docs/tutorial-basics/default-build-files)** - Learn best practices and advanced techniques
111+
4. **[Check the Command Reference](/docs/commands/Invoke-psake)** - Look up specific commands and their parameters
109112

110-
- **[Installing psake](/docs/tutorial-basics/installing)** - Installation methods and prerequisites
111-
- **[Running psake](/docs/tutorial-basics/run-psake)** - Your first psake build
112-
- **[Tasks](/docs/tutorial-basics/tasks)** - Understanding tasks and dependencies
113-
- **[Parameters and Properties](/docs/tutorial-basics/parameters-properties)** - Configuring your builds
114-
115-
### Build Type Examples
116-
117-
Learn how to use psake with different project types:
118-
119-
- **[.NET Solutions](/docs/build-types/dot-net-solution)** - Building .NET projects with MSBuild
120-
- **[Node.js Projects](/docs/build-types/nodejs)** - npm, TypeScript, and Webpack builds
121-
- **[Docker Builds](/docs/build-types/docker)** - Building and publishing Docker images
122-
123-
### CI/CD Integration
124-
125-
Integrate psake with your CI/CD pipeline:
126-
127-
- **[GitHub Actions](/docs/ci-examples/github-actions)** - Complete GitHub Actions setup
128-
- **[Azure Pipelines](/docs/ci-examples/azure-pipelines)** - Azure DevOps integration
129-
- **[GitLab CI](/docs/ci-examples/gitlab-ci)** - GitLab CI/CD configuration
130-
131-
### Troubleshooting
132-
133-
Having issues? Check these resources:
134-
135-
- **[Common Errors](/docs/troubleshooting/common-errors)** - Solutions to frequent problems
136-
- **[FAQ](/docs/troubleshooting/faq)** - Frequently asked questions
137-
- **[Debugging Guide](/docs/troubleshooting/debugging-guide)** - Debugging build scripts
138-
139-
### Reference
140-
141-
Quick reference and comprehensive documentation:
142-
143-
- **[Glossary](/docs/reference/glossary)** - Definitions of psake terms and concepts
144-
- **[Cheat Sheet](/docs/reference/cheat-sheet)** - Quick reference for common patterns
145-
- **[Configuration Reference](/docs/reference/configuration-reference)** - All configuration options
146-
- **[Exit Codes](/docs/reference/exit-codes)** - Understanding exit codes in CI/CD
113+
Need help? Visit our [Troubleshooting](/docs/troubleshooting/common-errors) section or join the [PowerShell Discord](https://aka.ms/psdiscord) #psake channel.

docusaurus.config.ts

Lines changed: 18 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -82,9 +82,21 @@ const config: Config = {
8282
items: [
8383
{
8484
type: 'docSidebar',
85-
sidebarId: 'tutorialSidebar',
85+
sidebarId: 'gettingStartedSidebar',
8686
position: 'left',
87-
label: 'Tutorial',
87+
label: 'Get Started',
88+
},
89+
{
90+
type: 'docSidebar',
91+
sidebarId: 'guidesSidebar',
92+
position: 'left',
93+
label: 'Guides',
94+
},
95+
{
96+
type: 'docSidebar',
97+
sidebarId: 'referenceSidebar',
98+
position: 'left',
99+
label: 'Reference',
88100
},
89101
{ to: '/blog', label: 'Blog', position: 'left' },
90102
{
@@ -101,16 +113,16 @@ const config: Config = {
101113
title: 'Docs',
102114
items: [
103115
{
104-
label: 'Quick Start',
116+
label: 'Get Started',
105117
to: '/docs/intro',
106118
},
107119
{
108-
label: 'Tutorial - Basics',
109-
to: '/docs/tutorial-basics/installing',
120+
label: 'Guides',
121+
to: '/docs/tutorial-basics/default-build-files',
110122
},
111123
{
112124
label: 'Command Reference',
113-
to: '/docs/commands/Assert',
125+
to: '/docs/commands/Invoke-psake',
114126
},
115127
{
116128
label: 'Code of Conduct',

sidebars.ts

Lines changed: 30 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
import type { SidebarsConfig } from '@docusaurus/plugin-content-docs';
22
import commands from "./docs/commands/docusaurus.sidebar.js";
3+
34
/**
45
* Creating a sidebar enables you to:
56
- create an ordered group of docs
@@ -11,26 +12,31 @@ import commands from "./docs/commands/docusaurus.sidebar.js";
1112
Create as many sidebars as you want.
1213
*/
1314
const sidebars: SidebarsConfig = {
14-
// By default, Docusaurus generates a sidebar from the docs folder structure
15-
tutorialSidebar: [
15+
// Getting Started - For newcomers and quick onboarding
16+
gettingStartedSidebar: [
1617
'intro',
18+
'tutorial-basics/installing',
19+
'tutorial-basics/getting-help',
20+
'tutorial-basics/run-psake',
21+
'tutorial-basics/tasks',
22+
'tutorial-basics/parameters-properties',
23+
],
24+
25+
// Guides - How-to guides, examples, and best practices
26+
guidesSidebar: [
1727
{
1828
type: 'category',
19-
label: 'Tutorial - Basics',
29+
label: 'Core Concepts',
2030
items: [
21-
'tutorial-basics/installing',
22-
'tutorial-basics/getting-help',
23-
'tutorial-basics/run-psake',
24-
'tutorial-basics/tasks',
25-
'tutorial-basics/parameters-properties',
2631
'tutorial-basics/default-build-files',
2732
'tutorial-basics/how-to-fail-a-build',
2833
'tutorial-basics/nested-build',
34+
'tutorial-advanced/structure-of-a-psake-build-script',
2935
],
3036
},
3137
{
3238
type: 'category',
33-
label: 'Tutorial - Advanced',
39+
label: 'Advanced Techniques',
3440
items: [
3541
'tutorial-advanced/access-functions-in-another-file',
3642
'tutorial-advanced/build-script-resilience',
@@ -39,13 +45,12 @@ const sidebars: SidebarsConfig = {
3945
'tutorial-advanced/outputs-and-artifacts',
4046
'tutorial-advanced/print-psake-task-name',
4147
'tutorial-advanced/retry-rules',
42-
'tutorial-advanced/structure-of-a-psake-build-script',
4348
'tutorial-advanced/variable-referencing',
4449
],
4550
},
4651
{
4752
type: 'category',
48-
label: 'Build Types',
53+
label: 'Build Type Examples',
4954
items: [
5055
'build-types/dot-net-solution',
5156
'build-types/nodejs',
@@ -54,7 +59,7 @@ const sidebars: SidebarsConfig = {
5459
},
5560
{
5661
type: 'category',
57-
label: 'CI Examples',
62+
label: 'CI/CD Integration',
5863
items: [
5964
'ci-examples/github-actions',
6065
'ci-examples/azure-pipelines',
@@ -64,28 +69,32 @@ const sidebars: SidebarsConfig = {
6469
'ci-examples/team-city',
6570
]
6671
},
72+
],
73+
74+
// Reference - Command reference, troubleshooting, and lookup materials
75+
referenceSidebar: [
6776
{
6877
type: 'category',
6978
label: 'Command Reference',
7079
items: commands
7180
},
7281
{
7382
type: 'category',
74-
label: 'Troubleshooting',
83+
label: 'Reference Materials',
7584
items: [
76-
'troubleshooting/common-errors',
77-
'troubleshooting/faq',
78-
'troubleshooting/debugging-guide',
85+
'reference/configuration-reference',
86+
'reference/cheat-sheet',
87+
'reference/glossary',
88+
'reference/exit-codes',
7989
]
8090
},
8191
{
8292
type: 'category',
83-
label: 'Reference',
93+
label: 'Troubleshooting',
8494
items: [
85-
'reference/glossary',
86-
'reference/cheat-sheet',
87-
'reference/configuration-reference',
88-
'reference/exit-codes',
95+
'troubleshooting/common-errors',
96+
'troubleshooting/faq',
97+
'troubleshooting/debugging-guide',
8998
]
9099
},
91100
{
@@ -94,19 +103,6 @@ const sidebars: SidebarsConfig = {
94103
id: 'code_of_conduct'
95104
},
96105
],
97-
98-
// But you can create a sidebar manually
99-
/*
100-
tutorialSidebar: [
101-
'intro',
102-
'hello',
103-
{
104-
type: 'category',
105-
label: 'Tutorial',
106-
items: ['tutorial-basics/create-a-document'],
107-
},
108-
],
109-
*/
110106
};
111107

112108
export default sidebars;

0 commit comments

Comments
 (0)