Conversation
|
Review the following changes in direct dependencies. Learn more about Socket for GitHub.
|
There was a problem hiding this comment.
Pull request overview
Adds a Jekyll-based static site to render and browse MIPs locally (and lays groundwork for future GitHub Pages deployment), while updating several existing MIPs’ front matter for consistent rendering.
Changes:
- Introduces Jekyll site scaffolding (config, layouts, landing page, favicon) for browsing MIPs.
- Adds local build/run instructions and Ruby/Bundler dependencies (Gemfile + lockfile).
- Updates MIP front matter fields (e.g.,
status,type) to improve consistency and site rendering.
Reviewed changes
Copilot reviewed 12 out of 15 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
index.md |
Adds landing page that lists MIPs in a table. |
favicon.svg |
Adds site favicon. |
_layouts/mip.html |
Adds per-MIP page layout with metadata table and citation block. |
_layouts/default.html |
Adds base HTML layout, styling, syntax highlighting, and link/author processing JS. |
_config.yml |
Configures Jekyll, permalinks, and assigns mip layout to MIPS/ files by default. |
README.md |
Documents local build/run steps for the site. |
MIPS/MIP-7.md |
Adds status and type front matter. |
MIPS/MIP-6.md |
Adds status and type front matter (and removes category). |
MIPS/MIP-5.md |
Adds status and type front matter. |
MIPS/MIP-4.md |
Adds status and type front matter. |
MIPS/MIP-3.md |
Normalizes front matter formatting; adds status/type; fixes copyright section indentation. |
Gemfile.lock |
Locks Ruby gem dependencies for reproducible local builds. |
Gemfile |
Adds Jekyll/minima/webrick dependencies. |
.gitignore |
Ignores Jekyll build/cache output. |
.github/workflows/deploy-pages.yml |
Adds (currently disabled) GitHub Pages workflow scaffold. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| @@ -0,0 +1,32 @@ | |||
| # Monad Improvement Proposals (MIPs) | |||
|
|
|||
| This repository builds a static MIP website with Jekyll and deploys it with GitHub Pages. | |||
There was a problem hiding this comment.
The README states the site “deploys … with GitHub Pages”, but the added Pages workflow has both jobs disabled (if: false). This is misleading for contributors trying to understand the current deployment setup; consider rewording to indicate Pages deployment is planned/optional or currently disabled.
| This repository builds a static MIP website with Jekyll and deploys it with GitHub Pages. | |
| This repository builds a static MIP website with Jekyll and is intended to be deployed with GitHub Pages (deployment may currently be disabled in CI). |
| if (window.Prism && typeof Prism.highlightElement === "function") { | ||
| var codeBlocks = document.querySelectorAll("pre > code, .highlighter-rouge pre > code"); | ||
|
|
||
| codeBlocks.forEach(function (code) { | ||
| var pre = code.parentElement; | ||
| if (!pre) { | ||
| return; | ||
| } | ||
|
|
||
| var languageClass = Array.from(code.classList).find(function (cls) { | ||
| return cls.indexOf("language-") === 0; | ||
| }); | ||
|
|
||
| if (!languageClass) { | ||
| var wrapper = code.closest("[class*='language-']"); | ||
| if (wrapper) { | ||
| languageClass = Array.from(wrapper.classList).find(function (cls) { | ||
| return cls.indexOf("language-") === 0; | ||
| }); | ||
| } | ||
| } | ||
|
|
||
| if (!languageClass || languageClass === "language-plaintext") { | ||
| return; | ||
| } | ||
|
|
||
| code.classList.add(languageClass); | ||
| pre.classList.add(languageClass); | ||
| Prism.highlightElement(code); | ||
| }); | ||
| } | ||
|
|
There was a problem hiding this comment.
_config.yml enables Rouge (highlighter: rouge and kramdown.syntax_highlighter: rouge), but this layout also loads Prism and calls Prism.highlightElement over all code blocks. That extra client-side highlighting work can cause flashing/reflow and makes styling harder to reason about (Prism theme vs Rouge CSS). Consider choosing one highlighter: either rely on Rouge output and remove Prism processing, or disable Rouge highlighting and use Prism consistently.
| if (window.Prism && typeof Prism.highlightElement === "function") { | |
| var codeBlocks = document.querySelectorAll("pre > code, .highlighter-rouge pre > code"); | |
| codeBlocks.forEach(function (code) { | |
| var pre = code.parentElement; | |
| if (!pre) { | |
| return; | |
| } | |
| var languageClass = Array.from(code.classList).find(function (cls) { | |
| return cls.indexOf("language-") === 0; | |
| }); | |
| if (!languageClass) { | |
| var wrapper = code.closest("[class*='language-']"); | |
| if (wrapper) { | |
| languageClass = Array.from(wrapper.classList).find(function (cls) { | |
| return cls.indexOf("language-") === 0; | |
| }); | |
| } | |
| } | |
| if (!languageClass || languageClass === "language-plaintext") { | |
| return; | |
| } | |
| code.classList.add(languageClass); | |
| pre.classList.add(languageClass); | |
| Prism.highlightElement(code); | |
| }); | |
| } |
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
README.mdon how to serve the siteMIP-1 Working Document(and to render correctly)