Skip to content

Commit 9bf4d71

Browse files
authored
Remove GitHub pages conflict code (#565)
The GitHub pages were failing to deploy due to some block code that was causing issues with GitHub pages deployment, rewrote those segments of the documentation.
1 parent be2b373 commit 9bf4d71

File tree

7 files changed

+65
-76
lines changed

7 files changed

+65
-76
lines changed

docs/architecture/app-directory.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,7 @@ export default function Home() {
138138
}, []);
139139

140140
return (
141-
<Box component='div' sx={{ /* styles */ }}>
141+
<Box component='div' sx={/* styles */}>
142142
<Banner aria-label='Landing banner' />
143143
<ProjectsGrid aria-label='Grid showing projects worked on' />
144144
<Publications aria-label='List of scientific publications' />
@@ -251,13 +251,15 @@ import { CircularProgress } from '@mui/material';
251251

252252
export default function Loading() {
253253
return (
254-
<div style={{ display: 'flex', justifyContent: 'center', padding: '2rem' }}>
254+
<div style={centeredContainerStyles}>
255255
<CircularProgress />
256256
</div>
257257
);
258258
}
259259
```
260260

261+
The container uses inline styles with flexbox centering: `display: 'flex'`, `justifyContent: 'center'`, and `padding: '2rem'`.
262+
261263
## 404 Not Found
262264

263265
Location: [`src/app/not-found.tsx`](../../src/app/not-found.tsx)

docs/architecture/components/avatar.md

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -179,17 +179,19 @@ useEffect(() => {
179179

180180
### Accessibility
181181

182-
```tsx
183-
<Box
184-
data-testid='profile_pic'
185-
aria-label='Profile picture'
186-
role='img'
187-
onMouseEnter={debounceHover}
188-
sx={{ cursor: 'pointer' }}
189-
>
190-
<Image src={image} alt='Alexander Sullivan profile picture' width={200} height={200} priority />
191-
</Box>
192-
```
182+
The avatar container includes proper accessibility attributes:
183+
184+
- `data-testid='profile_pic'` - Testing identifier
185+
- `aria-label='Profile picture'` - Screen reader label
186+
- `role='img'` - Semantic role for assistive technologies
187+
- `onMouseEnter={debounceHover}` - Hover interaction handler
188+
- `sx` prop with `cursor: 'pointer'` to indicate interactivity
189+
190+
The nested `Image` component includes:
191+
192+
- `alt='Alexander Sullivan profile picture'` - Descriptive alt text
193+
- `width={200}` and `height={200}` - Explicit dimensions
194+
- `priority` - Next.js optimization for above-the-fold content
193195

194196
## Component Interaction
195197

docs/architecture/components/cookie-snackbar.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -177,15 +177,14 @@ To customize the cookie snackbar:
177177
4. **Severity:** Change `severity='info'` to `success`, `warning`, or `error`
178178
5. **Position:** Add `anchorOrigin` prop to Snackbar for positioning
179179

180-
**Example Custom Position:**
180+
**Custom Position Configuration:**
181181

182-
```tsx
183-
<Snackbar
184-
onClose={handleClose}
185-
open={open}
186-
anchorOrigin={{ vertical: 'bottom', horizontal: 'center' }}
187-
>
188-
```
182+
The `anchorOrigin` prop accepts an object with two properties:
183+
184+
- `vertical`: Position on vertical axis (`'top'`, `'bottom'`)
185+
- `horizontal`: Position on horizontal axis (`'left'`, `'center'`, `'right'`)
186+
187+
Example: To center the snackbar at the bottom, set `anchorOrigin` to `vertical: 'bottom'` and `horizontal: 'center'`.
189188

190189
## Related Documentation
191190

docs/architecture/components/navbar.md

Lines changed: 15 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -61,28 +61,22 @@ logAnalyticsEvent('navbar_home', {
6161

6262
### 3. Responsive Design
6363

64-
Built with Material-UI AppBar and Toolbar:
64+
Built with Material-UI AppBar and Toolbar components:
6565

66-
```typescript
67-
<AppBar
68-
sx={{
69-
backgroundColor: '#131518',
70-
transition: 'all 0.5s ease-in-out',
71-
}}
72-
>
73-
<Toolbar
74-
sx={{
75-
fontSize: '1.25rem',
76-
height: '2rem',
77-
justifyContent: 'space-between',
78-
transition: 'all 0.5s ease-in-out',
79-
zIndex: 10,
80-
}}
81-
>
82-
{/* Navigation items */}
83-
</Toolbar>
84-
</AppBar>
85-
```
66+
**AppBar Styling:**
67+
68+
- `backgroundColor: '#131518'` - Dark background matching site theme
69+
- `transition: 'all 0.5s ease-in-out'` - Smooth transitions for state changes
70+
71+
**Toolbar Styling:**
72+
73+
- `fontSize: '1.25rem'` - Larger text for better readability
74+
- `height: '2rem'` - Compact height for minimal header footprint
75+
- `justifyContent: 'space-between'` - Distributes navigation items evenly
76+
- `transition: 'all 0.5s ease-in-out'` - Smooth transitions
77+
- `zIndex: 10` - Ensures navbar stays above other content
78+
79+
Both components use the MUI `sx` prop for styling with these properties.
8680

8781
### 4. Path-aware Behavior
8882

docs/architecture/components/stars.md

Lines changed: 9 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -70,16 +70,12 @@ Each star has:
7070

7171
### 3. Twinkle Animation
7272

73-
Stars twinkle using CSS animations:
73+
Stars twinkle using CSS animations applied through the `sx` prop. Each star receives:
7474

75-
```typescript
76-
sx={{
77-
animation: `twinkle ${star.animationDuration} infinite`,
78-
animationDelay: star.animationDelay,
79-
}};
80-
```
75+
- **animation:** `twinkle` with dynamic duration (using template literal with `star.animationDuration`) set to infinite
76+
- **animationDelay:** Random delay from `star.animationDelay` for staggered effect
8177

82-
The `twinkle` animation should be defined in global styles:
78+
The `twinkle` keyframe animation should be defined in global styles:
8379

8480
```scss
8581
@keyframes twinkle {
@@ -162,15 +158,11 @@ sequenceDiagram
162158

163159
The component uses proper ARIA attributes for screen readers:
164160

165-
```tsx
166-
<Box
167-
id='sky'
168-
aria-label='Starry background'
169-
component='div'
170-
role='img'
171-
sx={{...}}
172-
>
173-
```
161+
- `id='sky'` - Unique identifier for the container
162+
- `aria-label='Starry background'` - Descriptive label for assistive technologies
163+
- `component='div'` - Renders as a div element
164+
- `role='img'` - Identifies as an image for screen readers
165+
- `sx` prop contains styling with spread operator for dynamic styles
174166

175167
**Note:** Unlike decorative backgrounds that use `aria-hidden='true'`, this component uses `role='img'` with an `aria-label` because it's a significant visual element of the user experience.
176168

package-lock.json

Lines changed: 16 additions & 16 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@
5353
"@svgr/webpack": "^8.1.0",
5454
"@testing-library/jest-dom": "^6.9.1",
5555
"@testing-library/react": "^16.3.1",
56-
"@trivago/prettier-plugin-sort-imports": "^6.0.0",
56+
"@trivago/prettier-plugin-sort-imports": "^6.0.1",
5757
"@types/jest": "^30.0.0",
5858
"@types/lodash": "^4.17.21",
5959
"@types/node": "^25.0.3",

0 commit comments

Comments
 (0)