Skip to content

Commit 6b9ef43

Browse files
author
Brigit Murtaugh
committed
feat: update guidance for adding new HTML and markdown pages; remove obsolete prompts
1 parent b007c2f commit 6b9ef43

6 files changed

Lines changed: 49 additions & 23 deletions

File tree

.github/copilot-instructions.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1-
Every code change needs to be tested before it's committed. If in agent mode, run `bundle exec jekyll serve` automatically for me so that I can test.
1+
If the user would like to add a new page, clarify if this page is either a:
2+
* New main page of the website. This will be a .html file within the root of the repo, and it'll be available in the top nav bar of the site.
3+
* New page of the specification. This will be a .md file within the _implementors folder of the repo
4+
5+
For any new implementor spec pages, you should follow the guidance in the .github/prompts/new-page.prompt.md file.
6+
7+
Every code change (new page or otherwise) needs to be tested before it's committed. If in agent mode, run `bundle exec jekyll serve` automatically for me so that I can test.
28

39
End every response with "Happy Build!" on a new line.
Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,18 @@
11
---
22
applyTo: '**/*.html'
33
---
4+
## Guidance for new HTML website pages
45

5-
## Project coding standards for new HTML pages of the website
6-
7-
Every new HTML page should have a search bar added, similar to the search bar that's available on the features.html, templates.html, and collections.html pages.
6+
### Layout
7+
- Every new HTML page should have information like the following at the top, where the title is updated appropriately:
8+
```
9+
---
10+
layout: singlePage
11+
title: Dev Container Guides
12+
---
13+
```
14+
- The layout should come from the _layouts folder in the repo. Pages should default to `layout: singlePage`.
815

9-
Any new page should also be added to the end (far right) of the top nav bar of the website.
16+
### Content
17+
- Every new HTML page should have a search bar added toward the top, similar to the search bar that's available on the features.html, templates.html, and collections.html pages.
18+
- Make all headings clickable links.

.github/instructions/new-md-page.instructions.md

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,21 @@
22
applyTo: '**/*.md'
33
---
44

5-
## Project coding standards for new pages of the specification
5+
## Guidance for new markdown specification pages
66

7-
Every new specification page should be added to the _implementors folder, just like the pages in that folder already (like spec.md and features.md).
7+
### Layout
8+
- Any new page should have information like the following at the top, where the title, shortTitle, and index are updated appropriately:
9+
```
10+
---
11+
layout: implementors
12+
title: "Dev Container Templates distribution and discovery"
13+
shortTitle: "Templates distribution"
14+
author: Microsoft
15+
index: 8
16+
---
17+
```
18+
- The layout comes from the _layouts folder in the repo and will always be `layout: implementors` for pages of this type.
19+
20+
### Content
21+
- Add an emoji key before any paragraphs or tables using emojis
22+
- Make all headings clickable links

.github/prompts/html-page.prompt.md

Lines changed: 0 additions & 10 deletions
This file was deleted.

.github/prompts/md-page.prompt.md

Lines changed: 0 additions & 6 deletions
This file was deleted.

.github/prompts/new-page.prompt.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
mode: 'agent'
3+
---
4+
Your goal is to generate a new page for the website. The page should be similar to the existing pages in terms of layout and design.
5+
6+
If I don't specify initial content, generate some placeholder text.
7+
8+
Any new page should also be added to the end (far right) of the top nav bar of the website.
9+
10+
Any new implementor .md file should be added to the table of contents box visible within the /implementors route.
11+
12+
Every new page needs to be tested before it's committed. Run `bundle exec jekyll serve` automatically for me so that I can test.

0 commit comments

Comments
 (0)