feat(showcase): add Industrial Brutalism showcase website, docs folde… - #2
Merged
Merged
Conversation
…r, .nojekyll, and DESIGN.md specification
|
| GitGuardian id | GitGuardian status | Secret | Commit | Filename | |
|---|---|---|---|---|---|
| 35871206 | Triggered | Generic High Entropy Secret | 04cc6c2 | docs/app.js | View secret |
| 35871206 | Triggered | Generic High Entropy Secret | 04cc6c2 | showcase/app.js | View secret |
🛠 Guidelines to remediate hardcoded secrets
- Understand the implications of revoking this secret by investigating where it is used in your code.
- Replace and store your secrets safely. Learn here the best practices.
- Revoke and rotate these secrets.
- If possible, rewrite git history. Rewriting git history is not a trivial act. You might completely break other contributing developers' workflow and you risk accidentally deleting legitimate data.
To avoid such incidents in the future consider
- following these best practices for managing and storing secrets including API keys and other credentials
- install secret detection on pre-commit to catch secret before it leaves your machine and ease remediation.
🦉 GitGuardian detects secrets in your source code to help developers and security teams secure the modern development process. You are seeing this because you or someone else with access to this repository has authorized GitGuardian to scan your pull request.
👁️ ARGUS Code Review & Executive ScorecardThank you for your pull request! ARGUS has completed its 3-stage automated evaluation pipeline. 📊 Executive Summary
🎨 Stage 1: Atlas Visual Impact Map🔍 View Interactive Topology Flowchartflowchart TD
Node0["📄 ."]
Node1["📄 D"]
Node2["📄 d"]
Node3["📄 d"]
Node4["📄 s"]
Node5["📄 s"]
Node6["📄 s"]
Node7["📄 d"]
Node8["📄 d"]
Node9["📄 p"]
Node10["📄 s"]
Node11["📄 s"]
Node12["📄 s"]
Node13["📄 s"]
Node14["📄 s"]
Node15["📄 s"]
Node16["📄 s"]
🏛️ Stage 2: Athena Architecture GuardStatus: ✅ COMPLIANT All changes comply with defined architectural rules in architecture.md. ⚡ Stage 3: Hermes Technical Debt & Code Scanner
Report generated automatically by ARGUS AI PR Reviewer. |
There was a problem hiding this comment.
Pull request overview
This PR adds an “Industrial Brutalism” themed static showcase/docs website (HTML/CSS/JS) to demonstrate ARGUS’ 3-stage review concept, plus a design-system spec and small repo conveniences for serving and GitHub Pages.
Changes:
- Added interactive documentation/showcase pages under
docs/andshowcase/(provider switcher, PR diff “playground”, copy-to-clipboard). - Added
DESIGN.mddescribing the Industrial Brutalism design tokens and component rules. - Added
.nojekyllmarkers and apackage.jsonscript to serve the showcase locally.
Reviewed changes
Copilot reviewed 11 out of 11 changed files in this pull request and generated 9 comments.
Show a summary per file
| File | Description |
|---|---|
showcase/styles.css |
Industrial Brutalism CSS theme for the showcase site |
showcase/index.html |
Showcase landing page markup and sections (pipeline, providers, playground, quickstart) |
showcase/app.js |
Showcase interactivity (tabs, playground simulation, clipboard copy) |
showcase/.nojekyll |
Disables Jekyll processing for the showcase/ site output |
docs/styles.css |
Industrial Brutalism CSS theme for the docs site (mirrors showcase styling) |
docs/index.html |
Docs landing page markup and sections (mirrors showcase content) |
docs/app.js |
Docs interactivity (tabs, playground simulation, clipboard copy) |
docs/.nojekyll |
Disables Jekyll processing for the docs/ site output |
DESIGN.md |
Design system specification for the Industrial Brutalism theme |
.nojekyll |
Disables Jekyll processing at repo root (for Pages setups using root) |
package.json |
Adds npm run showcase script to serve the showcase/ directory |
Suppressed comments (5)
docs/index.html:376
- Footer community links point to files that are not present under the
docs/site root, so they will 404 when served from this folder. Use absolute GitHub links (or correct relative paths) so the docs site links work.
<a href="SECURITY.md" target="_blank">SECURITY.md</a>
<a href="CONTRIBUTING.md" target="_blank">CONTRIBUTING.md</a>
<a href="CODE_OF_CONDUCT.md" target="_blank">CODE_OF_CONDUCT.md</a>
</div>
showcase/index.html:376
- Footer community links point to files that are not present under the
showcase/folder, so they will 404 when served from this folder. Use absolute GitHub links (or correct relative paths) so the showcase site links work.
<a href="SECURITY.md" target="_blank">SECURITY.md</a>
<a href="CONTRIBUTING.md" target="_blank">CONTRIBUTING.md</a>
<a href="CODE_OF_CONDUCT.md" target="_blank">CODE_OF_CONDUCT.md</a>
</div>
docs/app.js:282
navigator.clipboard.writeText(...)returns a Promise and can fail (non-HTTPS contexts, denied permissions). Withoutawait/.catch, this can produce unhandled rejections and the UI will still show “COPIED!”. Handle failure and keep the button label consistent.
if (copyQsBtn && qsCode) {
copyQsBtn.addEventListener('click', () => {
navigator.clipboard.writeText(qsCode.textContent);
copyQsBtn.textContent = 'COPIED!';
setTimeout(() => copyQsBtn.textContent = 'COPY WORKFLOW', 2000);
});
}
showcase/app.js:110
navigator.clipboard.writeText(...)returns a Promise and can fail (non-HTTPS contexts, denied permissions). Withoutawait/.catch, this can produce unhandled rejections and the UI will still show “COPIED!”. Handle failure and keep the button label consistent.
if (copyProviderYamlBtn) {
copyProviderYamlBtn.addEventListener('click', () => {
navigator.clipboard.writeText(providerYamlCode.textContent);
copyProviderYamlBtn.textContent = 'COPIED!';
setTimeout(() => copyProviderYamlBtn.textContent = 'COPY YAML', 2000);
});
}
showcase/app.js:282
navigator.clipboard.writeText(...)returns a Promise and can fail (non-HTTPS contexts, denied permissions). Withoutawait/.catch, this can produce unhandled rejections and the UI will still show “COPIED!”. Handle failure and keep the button label consistent.
if (copyQsBtn && qsCode) {
copyQsBtn.addEventListener('click', () => {
navigator.clipboard.writeText(qsCode.textContent);
copyQsBtn.textContent = 'COPIED!';
setTimeout(() => copyQsBtn.textContent = 'COPY WORKFLOW', 2000);
});
}
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+367
to
+370
| <a href="architecture.md" target="_blank">architecture.md</a> | ||
| <a href="AGENTS.md" target="_blank">AGENTS.md</a> | ||
| <a href="AGENTS_AND_SKILLS.md" target="_blank">AGENTS_AND_SKILLS.md</a> | ||
| </div> |
Comment on lines
+367
to
+370
| <a href="architecture.md" target="_blank">architecture.md</a> | ||
| <a href="AGENTS.md" target="_blank">AGENTS.md</a> | ||
| <a href="AGENTS_AND_SKILLS.md" target="_blank">AGENTS_AND_SKILLS.md</a> | ||
| </div> |
Comment on lines
+43
to
+49
| html { | ||
| scroll-behavior: smooth; | ||
| background-color: var(--render-canvas); | ||
| color: var(--brand-white); | ||
| font-family: var(--font-body); | ||
| line-height: 1.6; | ||
| } |
Comment on lines
+43
to
+49
| html { | ||
| scroll-behavior: smooth; | ||
| background-color: var(--render-canvas); | ||
| color: var(--brand-white); | ||
| font-family: var(--font-body); | ||
| line-height: 1.6; | ||
| } |
Comment on lines
+104
to
+110
| if (copyProviderYamlBtn) { | ||
| copyProviderYamlBtn.addEventListener('click', () => { | ||
| navigator.clipboard.writeText(providerYamlCode.textContent); | ||
| copyProviderYamlBtn.textContent = 'COPIED!'; | ||
| setTimeout(() => copyProviderYamlBtn.textContent = 'COPY YAML', 2000); | ||
| }); | ||
| } |
Comment on lines
+94
to
+100
| if (data) { | ||
| provName.textContent = data.name; | ||
| provSdk.textContent = data.sdk; | ||
| provModel.textContent = data.model; | ||
| provBaseurl.textContent = data.baseurlNeeded; | ||
| providerYamlCode.textContent = data.yaml; | ||
| } |
Comment on lines
+94
to
+100
| if (data) { | ||
| provName.textContent = data.name; | ||
| provSdk.textContent = data.sdk; | ||
| provModel.textContent = data.model; | ||
| provBaseurl.textContent = data.baseurlNeeded; | ||
| providerYamlCode.textContent = data.yaml; | ||
| } |
Comment on lines
+132
to
+134
| + // TODO: Implement actual Stripe gateway connection later | ||
| + const apiKey = "sk_live_99481817161515151"; | ||
| console.log("Processing amount:", amount); |
Comment on lines
+132
to
+134
| + // TODO: Implement actual Stripe gateway connection later | ||
| + const apiKey = "sk_live_99481817161515151"; | ||
| console.log("Processing amount:", amount); |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request introduces a comprehensive design system specification and a new interactive JavaScript app for the ARGUS documentation, along with minor configuration improvements. The main additions are a detailed
DESIGN.mddescribing the "Industrial Brutalism" visual style and a feature-richdocs/app.jsthat powers provider selection, a live PR diff playground, and workflow YAML copy features in the docs site.Design system and documentation:
DESIGN.mdthat specifies the ARGUS Industrial Design System, including color tokens, typography, border and shadow styles, and detailed UI component guidelines. This establishes a consistent, high-contrast, developer-focused visual identity for the project.Documentation site interactivity:
docs/app.js, an interactive JavaScript app for the documentation site. It enables provider tab switching with dynamic YAML workflow code, a live PR diff playground simulating ARGUS review output, and copy-to-clipboard features for both provider YAML and quickstart workflow snippets.GitHub Pages configuration:
.nojekyllfiles to both the root anddocs/directories to ensure GitHub Pages serves files with underscores (e.g.,_-prefixed files) correctly.These changes significantly enhance the developer experience and documentation usability for ARGUS.