Skip to content

Add getting started guide and sample walkthrough #33

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
Copilot wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

Add getting started guide and sample walkthrough #33

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8808997
Initial plan
Copilot Jan 1, 2026
e2bcfec
Add getting started guide and sample walkthrough
Copilot Jan 1, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,20 @@
Workbench is a .NET CLI for managing Workbench documentation, work items, and
contracts in this repo.

## Getting Started

**New to Workbench?** Start here:

- **[Getting Started Guide](docs/00-overview/getting-started.md)**: Step-by-step tutorial covering installation, initialization, creating work items, and validation.
- **[Sample Walkthrough](examples/sample-walkthrough/)**: Hands-on example demonstrating the complete Workbench workflow.

## Repository map

- `src/Workbench`: CLI source code.
- `tests/`: automated tests.
- `docs/`: product, architecture, contracts, decisions, and runbooks.
- `docs/70-work/`: active and completed work items plus templates.
- `examples/`: sample walkthroughs and demonstrations.
- `assets/`: static assets used by docs or tooling.
- `artifacts/`: build outputs and local artifacts.
- `testdata/`: fixtures for parsing and validation tests.
Expand Down
Loading