Skip to content

Commit 94012da

Browse files
committed
Complete Phase 5: Add Reference documentation section
Add comprehensive reference documentation including: - Glossary: Definitions of all psake terms and concepts - Build terms, core concepts, execution control - Context and state, error handling, CI/CD terms - Advanced concepts and common patterns - Cheat Sheet: Quick reference guide - Installation and invocation patterns - Task definition patterns - Common build workflows - Useful one-liners and debugging tips - Configuration Reference: Complete configuration documentation - All Invoke-psake parameters - Build script configuration options - Task parameters and properties - $psake context object reference - Exec and Assert function documentation - Exit Codes: Exit code reference and CI/CD integration - Exit code behavior (success/failure) - Checking exit codes in different shells - CI/CD platform integration examples - Common scenarios and best practices - Troubleshooting exit code issues Also updated: - sidebars.ts: Added Reference category before Code of Conduct - intro.md: Added comprehensive Documentation Guide section with links to all major documentation areas including the new Reference section All pages follow established documentation style with: - Proper frontmatter (title, description) - Semantic headings and clear structure - Complete code examples with syntax highlighting - Cross-references to related pages - "See Also" sections for navigation
1 parent 0d2aef3 commit 94012da

File tree

7 files changed

+2923
-0
lines changed

7 files changed

+2923
-0
lines changed

docs/intro.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -100,3 +100,47 @@ to orchestrate their build process.
100100
* [J2N](https://github.com/NightOwl888/J2N)
101101
* [ICU4N](https://github.com/NightOwl888/ICU4N)
102102
* [RandomizedTesting](https://github.com/NightOwl888/RandomizedTesting)
103+
104+
## Documentation Guide
105+
106+
### Getting Started
107+
108+
New to psake? Start here:
109+
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

docs/reference/_category_.json

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{
2+
"label": "Reference",
3+
"position": 7,
4+
"link": {
5+
"type": "generated-index",
6+
"description": "Quick reference materials, glossary, and configuration documentation for psake."
7+
}
8+
}

0 commit comments

Comments
 (0)