Update contributing.md #225
Conversation
|
|
||
| <!-- Add content in markdown here --> | ||
|
|
||
| ## Explore What This Section Covers |
There was a problem hiding this comment.
We changed this to ## Explore This Section
| ``` | ||
| Some important things to note: |
There was a problem hiding this comment.
Watch spacing here. There should be a space between the code sample and the following sentence
| Some important things to note: | ||
|
|
||
| - The `title` represents the `<title>` tag and is used for SEO purposes | ||
| - The `description` represents the meta-description and is also used for SEO purposes | ||
| - The `icon` is used on index pages (`index.md`). So it should be an icon representative of the content on the page. You should stick to using Octicons 24px icons. You can search through the available icons on the [Primer Design System website](https://primer.style/foundations/icons) | ||
| - The `template` defines the template to be used. It should always be `main.html` for new content pages and `index-page.html` when adding a new section | ||
| - The `icon` is used on index pages (`index.md`). It should be an icon representative of the content on the page. You should stick to using Octicons 24px icons, ensuring they are outlined and not filled to maintain style consistency. You can search through the available icons on the [Primer Design System website](https://primer.style/foundations/icons) | ||
| - The `<div>` is populated with links to any pages or subdirectories and is populated automatically by a script at runtime that builds the landing pages |
There was a problem hiding this comment.
This is no longer relevant
| - The `<div>` is populated with links to any pages or subdirectories and is populated automatically by a script at runtime that builds the landing pages | ||
| - The `template` defines the template to be used. It should always `index-page.html` to correctly render the table of contents (TOC) |
There was a problem hiding this comment.
What do you mean the table of contents? Because the TOC is usually the navigation element that shows up on the right side of the page, so when I read this that's what I think about and that's incorrect. I think maybe the issue here is just the wrong use of words
| - The `<div>` is populated with links to any pages or subdirectories and is populated automatically by a script at runtime that builds the landing pages | ||
| - The `template` defines the template to be used. It should always `index-page.html` to correctly render the table of contents (TOC) | ||
| - The `## Explore What This Section Covers` serves as the title that acts as a divider between the content and the TOC |
There was a problem hiding this comment.
what content and what TOC?
| - The `<div>` is populated with links to any pages or subdirectories and is populated automatically by a script at runtime that builds the landing pages | ||
| - The `template` defines the template to be used. It should always `index-page.html` to correctly render the table of contents (TOC) | ||
| - The `## Explore What This Section Covers` serves as the title that acts as a divider between the content and the TOC | ||
| - The `:::INSERT_GENERATED_CARDS:::` is required for the `template` to function correctly and automatically generate the TOCs for each index |
There was a problem hiding this comment.
Ok, so yeah this pretty much confirms it. I don't think I would refer to this as the TOC because that is a specific element that appears on other pages. Instead, it should be referred to as the section cards, or something like that
There was a problem hiding this comment.
You are right. I mistook the the tocs with the section cards
| - The colors should be: | ||
| - Light mode: #262626 | ||
| - Dark mode: #e9e9e9 | ||
| Images should follow these specs: |
There was a problem hiding this comment.
There are no specs listed after this sentence
eshaben
added
A2 - Maintenance Minor
Description
This PR is a follow-up to PR #218. It includes information about the new standard for indexes and addresses the feedback provided in the previous PR.
Checklist
tanssi-mkdocsto update redirects