Skip to content

Commit ddf3762

Browse files
brunoborgesbrunoborges
authored
Initial commit
0 parents  commit ddf3762

15 files changed

Lines changed: 951 additions & 0 deletions

‎.github/copilot-instructions.md‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# Workshop Development Guidelines
2+
3+
This is a template workshop for GitHub Copilot Dev Days. Please follow these guidelines when contributing.
4+
5+
## Agent notes
6+
7+
- Explore the project before beginning code generation
8+
- Create todo lists for long operations
9+
- Before each step in a todo list, reread the instructions to ensure you always have the right directions
10+
- Always use instructions files when available, reviewing before generating code
11+
- Do not generate summary markdown files upon completion of a task
12+
- Always use absolute paths when running scripts and BASH commands
13+
- **Do NOT commit or push changes unless explicitly instructed to do so by the user**
14+
15+
## Workshop content guidelines
16+
17+
- Workshop steps are in the `workshop/` directory as numbered markdown files
18+
- Keep exercises focused and achievable within the stated time
19+
- Include clear success criteria for each exercise
20+
- Use GitHub-flavored markdown alerts (`> [!NOTE]`, `> [!TIP]`, etc.)
21+
- Place images in `workshop/images/`
22+
23+
## Publishing
24+
25+
- The `docs/` directory contains the HTML publishing framework
26+
- Update `docs/index.html` and `docs/step.html` when adding/removing workshop steps
27+
- The site deploys automatically to GitHub Pages on push to `main`
28+
29+
## Repository Structure
30+
31+
- `docs/`: Published HTML site (landing page + step viewer)
32+
- `workshop/`: Source markdown lessons (numbered `00-`, `01-`, etc.)
33+
- `.github/workflows/deploy.yml`: GitHub Pages deployment workflow
34+
- `.github/copilot-instructions.md`: This file — Copilot context config
35+
- `.github/instructions/`: Language/framework-specific instruction files

‎.github/workflows/deploy.yml‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
name: Deploy to GitHub Pages
2+
3+
on:
4+
push:
5+
branches: [main]
6+
workflow_dispatch:
7+
8+
permissions:
9+
contents: read
10+
pages: write
11+
id-token: write
12+
13+
concurrency:
14+
group: 'pages'
15+
cancel-in-progress: true
16+
17+
jobs:
18+
build-and-deploy:
19+
runs-on: ubuntu-latest
20+
environment:
21+
name: github-pages
22+
url: ${{ steps.deployment.outputs.page_url }}
23+
steps:
24+
- uses: actions/checkout@v4
25+
26+
- name: Prepare deployment
27+
run: |
28+
mkdir -p ./_site
29+
cp -r docs/* ./_site/
30+
touch ./_site/.nojekyll
31+
32+
- uses: actions/configure-pages@v4
33+
34+
- uses: actions/upload-pages-artifact@v3
35+
with:
36+
path: _site
37+
38+
- name: Deploy to GitHub Pages
39+
id: deployment
40+
uses: actions/deploy-pages@v4

‎.gitignore‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
.DS_Store
2+
3+
# build output
4+
dist/
5+
_site/
6+
7+
# dependencies
8+
node_modules/
9+
10+
# logs
11+
npm-debug.log*
12+
yarn-debug.log*
13+
yarn-error.log*
14+
pnpm-debug.log*
15+
16+
# environment variables
17+
.env
18+
.env.production
19+
20+
# macOS
21+
.DS_Store
22+
23+
# IDE settings
24+
.idea/
25+
.vscode/
26+
*.swp
27+
*.*~
28+
29+
# Python
30+
venv/
31+
.venv/
32+
__pycache__/
33+
*.py[cod]
34+
*$py.class
35+
.coverage
36+
htmlcov/
37+
38+
# .NET
39+
[Bb]in/
40+
[Oo]bj/
41+
*.suo
42+
*.user
43+
44+
# Java
45+
target/
46+
*.class
47+
*.jar
48+
49+
# SQLite
50+
*.db

‎LICENSE‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2023 GitHub
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.md‎

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
# Workshop Title
2+
3+
<!-- TODO: Update this with your workshop details -->
4+
5+
This repository contains the project for a guided workshop. Visit the published site or follow the workshop steps in the `workshop/` directory.
6+
7+
## Start the workshop
8+
9+
**To begin the workshop, start at [workshop/README.md](./workshop/README.md)**
10+
11+
Or visit the [published workshop site](https://copilot-dev-days.github.io/REPO_NAME).
12+
13+
## Repository Structure
14+
15+
```
16+
├── docs/ # Published HTML site (GitHub Pages)
17+
│ ├── index.html # Landing page
18+
│ ├── step.html # Step viewer (renders workshop/ markdown)
19+
│ ├── styles.css
20+
│ ├── light-theme.css
21+
│ └── theme-toggle.js
22+
├── workshop/ # Workshop content (markdown)
23+
│ ├── README.md # Workshop overview
24+
│ ├── 00-prereqs.md
25+
│ ├── 01-first-exercise.md
26+
│ ├── 02-second-exercise.md
27+
│ ├── 03-review.md
28+
│ └── images/ # Screenshots and diagrams
29+
├── .github/
30+
│ ├── copilot-instructions.md
31+
│ ├── instructions/
32+
│ └── workflows/deploy.yml
33+
├── README.md
34+
└── LICENSE
35+
```
36+
37+
## Customizing This Template
38+
39+
1. Update all `TODO` comments in `docs/index.html` and `docs/step.html`
40+
2. Replace the placeholder workshop steps in `workshop/`
41+
3. Update `REPO_NAME` references to your actual repository name
42+
4. Add your application code alongside the workshop content
43+
44+
## Publishing
45+
46+
The workshop site deploys automatically to GitHub Pages when you push to `main`. Enable GitHub Pages in your repository settings (Settings → Pages → Source: GitHub Actions).
47+
48+
## License
49+
50+
This project is licensed under the terms of the MIT open source license. Please refer to the [LICENSE](./LICENSE) for the full terms.
51+
52+
## Support
53+
54+
This project is provided as-is, and may be updated over time. If you have questions, please open an issue.

‎docs/index.html‎

Lines changed: 163 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,163 @@
1+
<!DOCTYPE html>
2+
<html lang="en">
3+
<head>
4+
<meta charset="UTF-8">
5+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
6+
<!-- TODO: Update the title -->
7+
<title>Workshop Title</title>
8+
<link rel="preconnect" href="https://fonts.googleapis.com">
9+
<link href="https://fonts.googleapis.com/css2?family=Space+Grotesk:wght@400;500;600;700&family=JetBrains+Mono:wght@400;600&display=swap" rel="stylesheet">
10+
<link rel="stylesheet" href="styles.css">
11+
<link rel="stylesheet" href="light-theme.css">
12+
<script src="theme-toggle.js"></script>
13+
</head>
14+
<body>
15+
<div style="position:fixed;top:1rem;right:1rem;z-index:1000;">
16+
<button class="theme-toggle" onclick="toggleTheme()">☀️ Light</button>
17+
</div>
18+
<section class="hero">
19+
<div class="container">
20+
<!-- TODO: Update badge, title, subtitle -->
21+
<div class="hero-badge">🚀 Hands-On Workshop</div>
22+
<h1>Workshop Title</h1>
23+
<p class="hero-subtitle">A hands-on workshop description goes here. Describe what participants will learn and build.</p>
24+
<div class="hero-cta">
25+
<a href="step.html?step=readme" class="btn btn-primary">🚀 Start Workshop</a>
26+
<!-- TODO: Update the GitHub repo URL -->
27+
<a href="https://github.com/copilot-dev-days/REPO_NAME" class="btn btn-secondary" target="_blank">⭐ GitHub Repo</a>
28+
</div>
29+
<div class="stats">
30+
<div class="stat">
31+
<!-- TODO: Update duration -->
32+
<div class="stat-value">~60min</div>
33+
<div class="stat-label">Duration</div>
34+
</div>
35+
<div class="stat">
36+
<!-- TODO: Update exercise count -->
37+
<div class="stat-value">3</div>
38+
<div class="stat-label">Exercises</div>
39+
</div>
40+
<div class="stat">
41+
<div class="stat-value">1</div>
42+
<div class="stat-label">Workshop</div>
43+
</div>
44+
</div>
45+
</div>
46+
</section>
47+
48+
<section class="features">
49+
<div class="container">
50+
<h2 class="section-title">What You'll Learn</h2>
51+
<!-- TODO: Update feature cards -->
52+
<div class="features-grid">
53+
<div class="feature-card">
54+
<div class="feature-icon">📝</div>
55+
<h3>Feature One</h3>
56+
<p>Description of the first key learning objective.</p>
57+
</div>
58+
<div class="feature-card">
59+
<div class="feature-icon">🔌</div>
60+
<h3>Feature Two</h3>
61+
<p>Description of the second key learning objective.</p>
62+
</div>
63+
<div class="feature-card">
64+
<div class="feature-icon">🤖</div>
65+
<h3>Feature Three</h3>
66+
<p>Description of the third key learning objective.</p>
67+
</div>
68+
<div class="feature-card">
69+
<div class="feature-icon">⚡</div>
70+
<h3>Feature Four</h3>
71+
<p>Description of the fourth key learning objective.</p>
72+
</div>
73+
</div>
74+
</div>
75+
</section>
76+
77+
<section class="workshop">
78+
<div class="container">
79+
<h2 class="section-title">Workshop Parts</h2>
80+
<!-- TODO: Update workshop steps to match your workshop/ markdown files -->
81+
<div class="parts-list">
82+
<a href="step.html?step=readme" class="part-card">
83+
<div class="part-number">📚</div>
84+
<div class="part-content">
85+
<h3>Workshop Overview</h3>
86+
<p>Introduction and learning objectives</p>
87+
</div>
88+
<span class="part-time">5 min</span>
89+
</a>
90+
<a href="step.html?step=00-prereqs" class="part-card">
91+
<div class="part-number">00</div>
92+
<div class="part-content">
93+
<h3>Prerequisites</h3>
94+
<p>Set up your environment</p>
95+
</div>
96+
<span class="part-time">10 min</span>
97+
</a>
98+
<a href="step.html?step=01-first-exercise" class="part-card">
99+
<div class="part-number">01</div>
100+
<div class="part-content">
101+
<h3>First Exercise</h3>
102+
<p>Description of the first exercise</p>
103+
</div>
104+
<span class="part-time">15 min</span>
105+
</a>
106+
<a href="step.html?step=02-second-exercise" class="part-card">
107+
<div class="part-number">02</div>
108+
<div class="part-content">
109+
<h3>Second Exercise</h3>
110+
<p>Description of the second exercise</p>
111+
</div>
112+
<span class="part-time">15 min</span>
113+
</a>
114+
<a href="step.html?step=03-review" class="part-card">
115+
<div class="part-number">03</div>
116+
<div class="part-content">
117+
<h3>Review & Next Steps</h3>
118+
<p>Recap and continue your learning</p>
119+
</div>
120+
<span class="part-time">5 min</span>
121+
</a>
122+
</div>
123+
</div>
124+
</section>
125+
126+
<section class="prereqs">
127+
<div class="container">
128+
<h2 class="section-title">Prerequisites</h2>
129+
<!-- TODO: Update prerequisites -->
130+
<div class="prereqs-grid">
131+
<div class="prereq-item">
132+
<span class="prereq-check">✓</span>
133+
<span>GitHub Account</span>
134+
</div>
135+
<div class="prereq-item">
136+
<span class="prereq-check">✓</span>
137+
<span>GitHub Copilot</span>
138+
</div>
139+
<div class="prereq-item">
140+
<span class="prereq-check">✓</span>
141+
<span>VS Code or IDE</span>
142+
</div>
143+
<div class="prereq-item">
144+
<span class="prereq-check">✓</span>
145+
<span>Git installed</span>
146+
</div>
147+
</div>
148+
</div>
149+
</section>
150+
151+
<footer>
152+
<div class="container">
153+
<div class="footer-links">
154+
<!-- TODO: Update footer links -->
155+
<a href="https://github.com/copilot-dev-days/REPO_NAME" target="_blank">GitHub Repository</a>
156+
<a href="https://code.visualstudio.com/docs/copilot/overview" target="_blank">Copilot Docs</a>
157+
<a href="https://github.com/github/awesome-copilot" target="_blank">Awesome Copilot</a>
158+
</div>
159+
<p class="footer-credit">Built with 💜 by the GitHub Copilot Team</p>
160+
</div>
161+
</footer>
162+
</body>
163+
</html>

0 commit comments

Comments
 (0)